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

Update static UID fka functionality. #326

Merged
merged 11 commits into from
Jan 31, 2024
Merged

Conversation

adobekan
Copy link
Collaborator

@adobekan adobekan commented Jan 25, 2024

  • improve backward compatibility
  • include strict mode = case sensitive for the semantic check
  • include additional tests

nwesem and others added 10 commits January 18, 2024 11:01
* to lowercase before patch

Signed-off-by: Adnan Bekan <[email protected]>

* Binary parser bug fix.

Signed-off-by: Ulf Bjorkengren <[email protected]>

---------

Signed-off-by: Adnan Bekan <[email protected]>
Signed-off-by: Ulf Bjorkengren <[email protected]>
Co-authored-by: Adnan Bekan <[email protected]>
Co-authored-by: Ulf Bjorkengren <[email protected]>
* to lowercase before patch

Signed-off-by: Adnan Bekan <[email protected]>

* Binary parser bug fix.

Signed-off-by: Ulf Bjorkengren <[email protected]>

---------

Signed-off-by: Adnan Bekan <[email protected]>
Signed-off-by: Ulf Bjorkengren <[email protected]>
Co-authored-by: Adnan Bekan <[email protected]>
Co-authored-by: Ulf Bjorkengren <[email protected]>
* add strict mode for case sensitivity

Signed-off-by: Niclas Wesemann <[email protected]>

* update documentation

Signed-off-by: Niclas Wesemann <[email protected]>

* fix trailing whitespace

Signed-off-by: Niclas Wesemann <[email protected]>

---------

Signed-off-by: Niclas Wesemann <[email protected]>
Signed-off-by: Niclas Wesemann <[email protected]>
* to lowercase before patch

Signed-off-by: Adnan Bekan <[email protected]>

* Binary parser bug fix.

Signed-off-by: Ulf Bjorkengren <[email protected]>

---------

Signed-off-by: Adnan Bekan <[email protected]>
Signed-off-by: Ulf Bjorkengren <[email protected]>
Signed-off-by: Niclas Wesemann <[email protected]>
Co-authored-by: Adnan Bekan <[email protected]>
Co-authored-by: Ulf Bjorkengren <[email protected]>
Signed-off-by: Adnan Bekan <[email protected]>
Signed-off-by: Niclas Wesemann <[email protected]>
docs/vspec2id.md Outdated
[-vt vspec_types_file] [-ot <types_output_file>] [--json-all-extended-attributes] [--json-pretty] [--yaml-all-extended-attributes] [-v version] [--all-idl-features]
[--gqlfield GQLFIELD GQLFIELD] [--validate-static-uid VALIDATE_STATIC_UID] [--only-validate-no-export]
[-q quantity_file] [-vt vspec_types_file] [-ot <types_output_file>] [--json-all-extended-attributes] [--json-pretty] [--yaml-all-extended-attributes] [-v version] [--all-idl-features]
[--gqlfield GQLFIELD GQLFIELD] [--jsonschema-all-extended-attributes] [--jsonschema-disallow-additional-properties] [--jsonschema-require-all-properties] [--jsonschema-pretty]
Copy link
Collaborator

Choose a reason for hiding this comment

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

We could potentially remove some fields that have no impact (and will not even be allowed after my vss-tools restructuring PR has been merged) like [--yaml-all-extended-attributes] and [--gqlfield GQLFIELD GQLFIELD]

@@ -93,14 +97,14 @@ warnings only:
| Data type | | Deprecation |
| Type (i.e. node type) | | Deleted Attribute |
| Unit | | Change description |
| Enum values (allowed) | | |
| Enum values (allowed) | | Qualified name (fka) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe a stupid question but what does "fka" means

@@ -43,6 +45,9 @@ cd path/to/your/vss-tools
Great, you generated your first overlay that will also be used as your validation file as soon as you update your
vehicle signal specification file.

If needed you can make the static UID generation case-sensitive using the command line argument `--strict-mode`. It
will default to false.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does case sensitive mean here? That two signals A.B and A.b get different UID so that renaming A.b to A.B is considered a name change?

@@ -78,11 +83,10 @@ A.B.NewName:
type: actuator
allowed: ["YES", "NO"]
description: A.B.NewName's old name is 'OldName'. And its even older name is 'OlderName'.
fka: ['A.B.OldName', 'A.B.OlderName']
fka: ['A.B.OlderName', 'A.B.OldName']
Copy link
Collaborator

@erikbosch erikbosch Jan 26, 2024

Choose a reason for hiding this comment

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

Does the order have any significance?

@erikbosch
Copy link
Collaborator

Looks good in general, I had some minor comments. The PR history is quite messy with merge commits (and cherry-picks?). I suggest that the PR author does a local squash and rebase on latest master and do a force update of the branch before merge, so that we can keep a clean history on master.

* check if fka is a list

Signed-off-by: Adnan Bekan <[email protected]>

* update documentation

Signed-off-by: Adnan Bekan <[email protected]>

---------

Signed-off-by: Adnan Bekan <[email protected]>
@erikbosch
Copy link
Collaborator

MoM: Decision: Merge when maintainer happy

Copy link
Collaborator

@erikbosch erikbosch left a comment

Choose a reason for hiding this comment

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

OK when squashed

@erikbosch erikbosch merged commit fb7a0b1 into COVESA:master Jan 31, 2024
4 of 5 checks passed
erikbosch pushed a commit that referenced this pull request May 3, 2024
* add strict mode for case sensitivity

Signed-off-by: Niclas Wesemann <[email protected]>
Signed-off-by: Adnan Bekan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants