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.

Sign up for GitHub

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

Jump to bottom

[New Model]: Failure Pattern #689

Merged
merged 6 commits into from
Mar 12, 2024
Merged

[New Model]: Failure Pattern #689

merged 6 commits into from
Mar 12, 2024

Conversation

JulianSchererZF
Copy link
Contributor

@JulianSchererZF JulianSchererZF commented Feb 29, 2024 •
edited by agg3fe
Loading

Description

-->

Closes #620

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the SAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar samm-cli.jar aspect <path-to-aspect-model> validate ). The SAMM CLI is available here and in GitHub
  • use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
  • the identifiers for all model elements start with a capital letter except for properties
  • the identifier for properties starts with a small letter
  • all model elements at least contain the fields "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
  • Property and the referenced Characteristic should not have the same name
  • the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
  • use abbreviations only when necessary and if these are sufficiently common
  • avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
  • fields preferredName and description are not the same
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
  • units are referenced from the SAMM unit catalog whenever possible
  • use constraints to make known constraints from the use case explicit in the aspect model
  • when relying on external standards, they are referenced through a "see" element
  • all properties with an simple type have an example value
  • metadata.json exists with status "release"
  • generated json schema validates against example json payload
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes
  • all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

  • All required reviewers have approved this PR (see reviewers section)
  • The new aspect (version) will be implemented by at least one data provider
  • The new aspect (version) will be consumed by at least one data consumer
  • There exists valid test data
  • In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
  • The model has at least version '1.0.0'
  • If a previous model exists, model deprecation has been checked for previous model
  • The release date in the Release Note is set to the date of the MS3 approval

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 1, 2024

Validation Report for io.catenax.failure_pattern/1.0.0/FailurePattern.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2024

Validation Report for io.catenax.failure_pattern/1.0.0/FailurePattern.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2024

Validation Report for io.catenax.failure_pattern/1.0.0/FailurePattern.ttl

Input model is valid

@JulianSchererZF JulianSchererZF marked this pull request as draft March 4, 2024 12:06
@JulianSchererZF JulianSchererZF marked this pull request as ready for review March 4, 2024 12:06
@JulianSchererZF
Copy link
Contributor Author

@agg3fe ready for review

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
@@ -0,0 +1,272 @@

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright headers are missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added copyright headers

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
samm:dataType xsd:string ;
samm-c:values ( "equal" "not_equal" ) .

:TimtstampInsideOperatorEnumeration a samm-c:Enumeration ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo in TimtstampInsideOperatorEnumeration

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed typo

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
samm:description "This regular expression ensures that the version is [1-9].[0-9].[0.9]"@en ;
samm:value "^[1-9].[0-9].[0-9]$" .

:StringExpressionList a samm-c:List ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName and description missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted unused list

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
:StringExpressionList a samm-c:List ;
samm:dataType :StringExpression .

:DateExpressionList a samm-c:List ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName and description missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted unused list

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
:DateExpressionList a samm-c:List ;
samm:dataType :TimestampExpression .

:BooleanExpressionList a samm-c:List ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName and description missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted unused list

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
:BooleanExpressionList a samm-c:List ;
samm:dataType :BooleanExpression .

:OutsideOperatorEnumeration a samm-c:Enumeration ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName and description missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted unused enumeration

agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated

:booleanPropertyName a samm:Property ;
samm:preferredName "Boolean property name"@en ;
samm:description "A property name of type booleanfrom the model."@en ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo booleanfrom

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed typo

agg3fe
agg3fe requested changes Mar 7, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check my comments

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 7, 2024

Validation Report for io.catenax.failure_pattern/1.0.0/FailurePattern.ttl

Input model is valid

@JulianSchererZF JulianSchererZF requested a review from agg3fe March 7, 2024 13:31
agg3fe
agg3fe reviewed Mar 7, 2024
View reviewed changes
io.catenax.failure_pattern/1.0.0/FailurePattern.ttl Outdated
@@ -0,0 +1,278 @@
#######################################################################
# Copyright (c) 2022, 2024 Robert Bosch GmbH
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is first version, only 2024 is required.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ja surem, fixed that as well

@JulianSchererZF JulianSchererZF requested a review from agg3fe March 7, 2024 13:51
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 7, 2024

Validation Report for io.catenax.failure_pattern/1.0.0/FailurePattern.ttl

Input model is valid

agg3fe
agg3fe approved these changes Mar 7, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@agg3fe agg3fe added MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br labels Mar 7, 2024
@agg3fe agg3fe merged commit 15cb8e3 into eclipse-tractusx:main Mar 12, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe approved these changes

Assignees
No one assigned
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JulianSchererZF @agg3fe