Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preliminary fix for assemble-turnstile-data.yml workflow #983

Merged
merged 1 commit into from
Jul 28, 2023

Conversation

tuxji
Copy link
Contributor

@tuxji tuxji commented Jul 24, 2023

I just tested the RACK Build Virtual Machine Workflow. It failed while trying to assemble the Turnstile ingestion package:

    - name: Assemble Turnstile ingestion package
      run: |
        RACK/Turnstile-Example/Assemble-TurnstileData.sh
ERROR: -g load_local_model('/home/runner/work/RACK/RACK/RACK/Turnstile-Example/../GE-Ontology'): directory_files/2: file `'/home/runner/work/RACK/RACK/RACK/Turnstile-Example/../GE-Ontology'' does not exist
Error: Process completed with exit code 2.

Someone moved the GE-Ontology directory into the overlays directory a while ago, but did not update the Turnstile instructions. This pull request fixes the location of the GE-Ontology directory in Turnstile-Example/Assemble-TurnstileData.sh, but I need someone else to update the Turnstile instructions. RACK has changed the method used to ingest ingestion packages; the new method now uses the rack-ui interface instead of shell scripts or the rack CLI. Some of the shell scripts mentioned in the instructions don't exist anymore. If we still need to assemble the Turnstile ingestion package and tell users how to ingest it, will someone please modify this pull request to update these README files with the correct instructions too?

overlays/GE-Ontology/README.md
4:GE-Ontology/
46:21 rack model import ../GE-Ontology/OwlModels/import.yaml
50:Line 21 uses the [CLI](../cli) to import the owl model specified in import.yaml. In this case, it lists GE.owl. Line 23 imports the ingestion nodegroups based on the GE-Ontology overlay. Note that the owl and the nodegroups have to be copied out of RACK-in-a-Box by running [setup-owl.sh](../cli/setup-owl.sh). Note also that the name of the ingestion nodegroup directory is taken from the uri of the ontology overlay file: `arcos.projectName`.

Turnstile-Example/README.md
11:The Turnstile overlay is created in a file called [GE.sadl](../GE-Ontology/ontology/GE.sadl). For the ARCOS program, overlays are created by individual performers and are named after the prime. For example, the turnstile ontology is created by the GE-Galois team. The overlay file is located in a directory called [GE-Ontology](../GE-Ontology/) (where GE is the prime). The structure and content of the directory is as follows:
13:GE-Ontology/
33:Let's take a look at the [GE.sadl](../GE-Ontology/ontology/GE.sadl) file.
56:Now let's look at the [setup-GE.sh](../GE-Ontology/setup-GE.sh) script.
62:Line 24 uses the [CLI](../cli) to import the owl model specified in import.yaml. In this case, it lists GE.owl. Line 25 uses the imports the ingestion nodegroups based on the GE-Ontology overlay. Note the name of the ingestion nodegroup directory is taken from the uri of the ontology overlay file: `arcos.projectName`.

Turnstile-Example/Turnstile-IngestionPackage/Objectives/README.md
3:- Created nodegroups to relate ACTIVITYs from the GE-Ontology overlay to OBJECTIVEs from the [DO-178C ontology](https://github.com/ge-high-assurance/RACK/blob/TurnstileUpdate/RACK-Ontology/ontology/DO-178C/DO-178C.sadl). 
8:The following table summarizes the identified OBJECTIVEs `satisfiedBy` the ACTIVITYs. (Note: the listed ACTIVITYs are part of the GE-Ontology overlay.)

Turnstile-Example/Turnstile-IngestionPackage/README.md
27:The script [setup-turnstile.sh](../../cli/setup-turnstile.sh) loads the [GE ontology overlay](../../GE-Ontology/ontology/GE.sadl). 

assist/bin/README.md
59:  ingest_data -O GE-Ontology/OwlModels http://rack001/turnstiledata Turnstile-Example/Turnstile-IngestionPackage
138:         -O ../../../GE-Ontology \
169:         -O ../../../GE-Ontology \
249:load_local_model('./GE-Ontology/OwlModels').

@tuxji tuxji requested a review from kityansiu July 24, 2023 20:51
@chrisage chrisage self-requested a review July 26, 2023 13:55
@chrisage chrisage added the bug Something isn't working label Jul 26, 2023
@glguy glguy self-requested a review July 28, 2023 16:34
@glguy
Copy link
Contributor

glguy commented Jul 28, 2023

I'm fixing up the README now

@tuxji
Copy link
Contributor Author

tuxji commented Jul 28, 2023

@glguy I reformatted the READMEs, but two files still need another pass to update out-of-date instructions. Please see my most recent commit message (44dae1e).

@glguy
Copy link
Contributor

glguy commented Jul 28, 2023

@tuxji I pulled out the mention of setup-turnstile.sh. I believe everything that used to do is now contained in the Assemble script and is covered by the manifest import command.

Need to update script and instructions after move of GE-Ontology into
overlays directory to account for manifests and overlays.  Also wrap
long lines containing whole sentences and/or paragraphs since Markdown
ignores newlines inside paragraphs and uses a blank line by itself to
recognize paragraph breaks.

Turnstile-Example/Assemble-TurnstileData.sh: Update location of
GE-Ontology directory.

Turnstile-Example/README.md: Wrap long lines and insert blank lines.
Update out-of-date snippets of example files.  Fix links to renamed
files.

Turnstile-Example/Turnstile-IngestionPackage/BuildProcess/README.md:
Wrap long lines.

Turnstile-Example/Turnstile-IngestionPackage/CounterApplicationImplementation/README.md:
Wrap long lines.

Turnstile-Example/Turnstile-IngestionPackage/Objectives/README.md:
Wrap long lines and insert blank lines.

Turnstile-Example/Turnstile-IngestionPackage/README.md: Wrap long
lines.  Remove now-unnecessary instructions since setup-turnstile.sh
is gone.

assist/bin/README.md: Update location of GE-Ontology directory.
Re-wrap lines.
@tuxji tuxji merged commit 6901a2c into master Jul 28, 2023
@tuxji tuxji deleted the ji/fix-turnstile branch July 28, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants