search

ucoProject / UCO

This repository is for development of the Unified Cyber Ontology.
Apache License 2.0
80 stars 34 forks source link

Rename ToolConfigurationTypeFacet to ToolConfigurationFacet in tool.ttl #451

Closed gwebb-case closed 2 years ago

gwebb-case commented 2 years ago

(This issue was migrated from CASE Issue 97.)

Background

The facet name "ToolConfigurationTypeFacet" is required, but the text "Type" within its name is no longer relevant

Requirements

Remove the text "Type" from the UCO ontology for the following Facet:

so that it becomes

Requirement 1

Rename to "ToolConfigurationFacet" from ToolConfigurationTypeFacet, and associated comment, within the turtle file tool.ttl A total of four (4) changes in tool.ttl (lines 359, 365-366, and 379)

Requirement 2

Update CASE-Examples to reflect the facet name change Check all examples within the master branch of: https://github.com/casework/CASE-Examples/tree/master/examples/

for any references affected by the change. i.e. run a keyword search across all the files in the above folder, and all its sub-folders, for "ToolConfigurationTypeFacet" Known changes:

Note: This part of the requirement is listed as Issue 97 in the CASE github repository

Risk / Benefit analysis

Benefits

The change will bring the facet name inline with the more modern representation of this facet, and provides better conformance with the standard CASE Facet guidance.

Risks

Low Risk

  1. The two (2) CASE-Examples listed in requirement 2 will be made at the same time to ensure they are remain compatible with this change.

  2. Any developer code which currently hard codes the json-ld output using the existing "ToolConfigurationTypeFacet" name will need to amended to allow compability with future UCO\CASE versions. Note: Code which automatically generates output data directly from the versioned *.ttl files will be unaffected by the change. Forked examples may not, by default, have the change in their existing copy.

Competencies demonstrated

After the change, re-run a text search across all the files in the following repositories:

Competency 1

Competency Question 1.1

Check that no hits are generated for the text pattern "ToolConfigurationTypeFacet" (case insensitive) in tool.ttl

Result 1.1

The result should not return any Hits.

Competency Question 1.2

Check that three (3) hits are generated for the text pattern "ToolConfigurationFacet" (case insensitive)

Result 1.2

The result should return exactly 3 Hits within tool.ttl (on lines 359, 365 and 379 only).

Solution suggestion

Rename ToolConfigurationTypeFacet to ToolConfigurationFacet in tool.ttl, and update CASE-Examples which reference this facet.

Coordination

ajnelson-nist commented 2 years ago

The OC requested a follow-on issue for removing "Type" from other class names. I'd be happy to fast-track it.

ajnelson-nist commented 2 years ago

Ah, dear. This was re-filed from CASE without cross-linking when I was addressing many other issues. I missed adding it to the agenda for last Thursday, so we did not discuss it or hold a Solutions Approval vote.

There's a good chance that this will have to be our kick-off of the 2.0.0 merging and reviewing practices.

eoghanscasey commented 2 years ago

This is such a simple change that the Requirement review was effectively a Solution review = remove the word "Type" from ToolConfigurationTypeFacet.

I recommend making this change without further voting.

sbarnum commented 2 years ago

I concur that this is a VERY localized change and that the Requirement review approval should be okay as a solution approval. I just reviewed the PR and verified that the changes are specifically limited to the proposed changes agreed to in the Requirements review.

ajnelson-nist commented 2 years ago

@eoghanscasey , @sbarnum , thank you. We'll proceed with this as a Fast Track proposal having already received its necessary vote.

ajnelson-nist commented 2 years ago

This turned out to be obviated by Issue 432. Closing as (indirectly) accomplished. @b0bkaT , no need to document on the website.