Documentation about the workflow

[NicoRobertIn]

I was asked to check the current workflow on the project, I took some notes and @DrLeturc proposed to open an issue to discuss about adding some documentation about. So here we are. What do you think?

Workflow

As far as I understood, on .github side we have a workflow, which involves:

• push on master triggers deploy
• deploy involves
  • creating an ubuntu environment
  • installing python 3
  • installing the requirements in .acimov
  • installing pyLODE (skos_tags branch)
    • see issue #168
  • launch process_core.py (we see later what it contains)

The .acimomv folder contains 3 scripts, as far as I understood only process_core.py is plugged into automatic processes. We have:

• process_core.py
  • for each turtle file in src (iteration over static list…?)
    • check if the syntax is valid
    • checks if there is one and only one ontology declaration
    • checks if this declaration has a dct:created property
      • otherwise (the case of all the modules on master, but it makes totally sense), adds the file creation date on git in the graph
      • it outputs the debug logger if there is already a date in the graph that is different from the file creation date on git
    • checks if the ontology has a dct:modified property
      • adds it dynamically if it has not (so all the time in the project which is way less annoying)
    • pyLODE uses the html heads and tails with the ontology to generate a HTML documentation)
      • in French and in English
    • it copies the turtle file from src folder into a folder named public
      • probably that the doc points to these rdf files so that we keep the “”real”” ones into a private folder
    • write different representations of the ontology in public in:
      • rdf
      • json-ld
      • n3
      • nt
    • dynamically write a .htaccess
      • rewrite all URLs with format /hmas/ontologyTerm
      • into /hmas/ontologyName#ontologyTerm
• owl-profile-checker-test.py
  • WIP
  • loads the ontology into Corese and captures the output
  • the intent was to test the consistency of the ontologies depending on the OWL profile
  • for now is just plugged on a tutorial RDF graph about the Beatles
• test_scenarios.py
  • still a little but of WIP in there
  • contains lists of test functions
    • relies on the README.md files on top of the files in the domains hierarchy
      • relies on a version of mistune that does not implement blank lines… so we have to watch out when upgrading mistune
    • validity of scenarii tests
      • Do we have a title?
      • Do we have a description?
      • Do we have at least one CQ?
      • Does the scenario introduce at least one term?
      • Does the scenario have a modelet with at least one term?
      • Do we have a dataset?
      • Does each CQ have its question?
    • tests on CQs
      • Do we have a sparQL request related to the CQ?
        • note: it only checks if the file exists…
      • Does the request returns something?
        • note: Should we have a TDD approach implying to write the result before developing and then compare the sparQL result with its expected result?
    • tests on domain
      • totally WIP
    • tests on terms
      • totally WIP
      • What is yet to do:
        • Does the term exist in only one scenario?
        • Does the term exist in at least one scenario?
  • we scan the domains folder
    • for each folder
      • we launch the domain tests (which are right now WIP)
      • for each subfolder
      • we parse the README.md
        • out of its content we launch
          • scenarii validity tests
          • CQ tests
  • it ends up with an error report

[FabienGandon]

@NicoRobertIn : Has this content been moved to a documentation of the project? It seems we should add this to one of our markdown file and close the issue?

[NicoRobertIn]

It was not moved into the project for now Should we make a README.md in the workflow folder? https://github.com/HyperAgents/hmas/tree/master/.github/workflows It could embed some documentation about the deploy and model-test workflows

[NicoRobertIn]

@FabienGandon Some documentation on the workflows was added there: https://github.com/HyperAgents/hmas/tree/test-workflow/.github/workflows

It will be available in the main branch after a merge with the test-workflow branch

A pull request should be open today