feat: report unsupported AutoYaST elements #1976

imobachgs · 2025-02-05T14:48:49Z

Problem

Agama does not offer information about which elements are supported when importing an AutoYaST profile and which ones are just ignored.

https://trello.com/c/0u2wwMN2

Solution

Agama checks the profile for unsupported elements. If it finds them, it displays a question listing them and asking the user whether to continue.

Generating the documentation

The mechanism to detect unsupported elements includes a list of all AutoYaST elements and whether they are supported: "yes", "planned", "partial" or "no". The file also contains hints about replacing some elements (e.g., using a post-script).

Although it was out of scope, this PR introduces a new doc:autoyast_compat which generates a reference to be included in the AutoYaST support documentation. Not all elements are included, but we can create a follow-up PBI to work on that.

Disabling the check

It is possible to disable the check specifying agama.ay_check=0 on kernel's command line. Actually, the check is done, but it does not report found problems.

Testing

Added a new unit test
Tested manually

Screenshots

Below is an example of the AutoYaST compatibility documentation automatically generated by the new doc:autoyast_compat task.

To do

Improve how the error is displayed.
Allow disabling the check.
Add all (or at least most of them) the AutoYaST elements to the autoyast-compat.json file.

* Improve the structure of the data, adding proper support for nested elements.

…ements

coveralls · 2025-02-07T14:59:51Z

Pull Request Test Coverage Report for Build 13202155965

Details

1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
9 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.02%) to 70.888%

Files with Coverage Reduction	New Missed Lines	%
service/lib/agama/autoyast/connections_reader.rb	4	93.75%
rust/agama-server/tests/common/mod.rs	5	74.19%

Totals
Change from base Build 13198839713:	-0.02%
Covered Lines:	17291
Relevant Lines:	24392

💛 - Coveralls

mvidner

Comments based so far on the description only, not on code.

Agama checks the profile for unsupported elements.

When does this happen? Only when I try to use the profile, or can I trigger it beforehand, on a dry run?
"Not supported AY elements" popup

I think it would be nice to also include this text.

This popup can be disabled by passing agama.ay_check=0 on the kernel command line

mvidner · 2025-02-07T16:11:48Z

2. "Not supported AY elements" popup

Also IIUC the popup displays the "planned" and "no" categories. What about "partial"?

mvidner · 2025-02-07T15:56:30Z

web/src/components/questions/Questions.tsx

@@ -53,5 +54,9 @@ export default function Questions(): React.ReactNode {
    QuestionComponent = LuksActivationQuestion;
  }

+  if (currentQuestion.class === "autoyast.unsupported") {


Please add a table item to doc/questions.md

web/src/components/questions/UnsupportedAutoYaST.tsx

mvidner · 2025-02-07T16:21:16Z

service/lib/agama/autoyast/profile_checker.rb

+  module AutoYaST
+    # This class checks an AutoYaST profile and determines which unsupported elements are used.
+    #
+    # It does not report unknown elements.


So what happens with unknown elements? Are they silently ignored now or does a different part of Agama report them?

I decided to ignore them by now and report only the status of the known elements. The idea is to extend the compat file to cover all the AutoYaST elements, stating whether it is unsupported, supported or planned.

Co-authored-by: Martin Vidner <mvidner@suse.cz>

imobachgs · 2025-02-07T16:48:24Z

2. "Not supported AY elements" popup
Also IIUC the popup displays the "planned" and "no" categories. What about "partial"?

The "partially supported" elements are meant for container elements. When you check the profile, they are not relevant: the important part is the element within. For instance, if you have the following code:

<networking>
  <backend>wicked</backend>
</networking>

Agama will report that networking/backend is unsupported, regardless of the networking status.

However, the "partial" category can be used when generating the AutoYaST compatibility documentation.

imobachgs · 2025-02-07T16:51:23Z

Comments based so far on the description only, not on code.

1. Agama checks the profile for unsupported elements.
   When does this happen? Only when I try to use the profile, or can I trigger it beforehand, on a dry run?

Well, it happens automatically when using an AutoYaST profile (agama.auto=) in kernel's command line. However, I use the following command:

agama-autoyast http://192.168.122.10/autoyast/wrong.xml autoinst

IMHO, agama-autoyast should be "hidden" (probably placed on /usr/libexec) and we should extend the CLI to allow this operation. What do you think?

2. "Not supported AY elements" popup
   I think it would be nice to also include this text.
   > This popup can be disabled by passing agama.ay_check=0 on the kernel command line

Good point.

dgdavid

Interface Code LGTM

dgdavid · 2025-02-07T18:07:31Z

2. "Not supported AY elements" popup
I think it would be nice to also include this text.
> This popup can be disabled by passing agama.ay_check=0 on the kernel command line

+1

and remove 'support: yes' from users[], it is implicit on all items with 'children'

zypper install python3-jsonschema.rpm jsonschema -i autoyast-compat.json autoyast-compat.schema.json TODO: check in CI, maybe make `agama profile validate` a bit more generic

mvidner · 2025-02-07T21:07:55Z

service/share/autoyast-compat.json

@@ -68,6 +68,7 @@
          { "key": "description", "support": "no" },
          {
            "key": "bootproto",
+            "support": "no",


@imobachgs Creating the schema did help finding the missing support here. Yay! Is no right?

mvidner · 2025-02-10T09:40:15Z

In today's review you mentioned the problem of keeping the JSON in sync with the code.
I know that automating the synchronization would be hard... can we at least detect automatically that the JSON and the implementation have gone out of sync?

imobachgs force-pushed the profile-checker branch from 08506d9 to 277eb9d Compare February 6, 2025 12:05

imobachgs added 11 commits February 6, 2025 16:43

refactor(ruby): split profile fetching and conversion

e21a294

feat(ruby): find unsupported elements in the AutoYaST profile

25d328a

feat(ruby): report AutoYaST unsupported elements

84915a2

feat: extend the AutoYaST profile definition

682381b

* Improve the structure of the data, adding proper support for nested elements.

feat(ruby): improve support level calculation

f8abcb6

feat(ruby): add network elements to AutoYaST compatibility

a1e8ff3

fix(ruby): make RuboCop happy

bc0fbd4

chore(ruby): remove useless shebang lines

1e8ecaf

fix(ruby): rake task to the top-level Rakefile

56fd289

fix(ruby): fix handling of unknown AutoYaST elements

d5ec2b6

feat(web): add an specific question to handle AutoYaST unsupported el…

b621c12

…ements

imobachgs force-pushed the profile-checker branch from 0c0b499 to b621c12 Compare February 6, 2025 16:43

imobachgs added 4 commits February 7, 2025 06:45

chore(ruby): drop ProfileFetcher#copy_files (unused)

dcdab34

fix(ruby): do not read the profile if it was not fetched

fb9039f

fix(ruby): use a slash (/) for AutoYaST element path separator

f33c81e

feat(web): improve UnsupportedAutoYaST component

5b14f30

imobachgs force-pushed the profile-checker branch 2 times, most recently from 80a1704 to 4e515bd Compare February 7, 2025 14:18

chore(ruby): allow disabling the AutoYaST check

2b110d6

imobachgs force-pushed the profile-checker branch from 4e515bd to 2b110d6 Compare February 7, 2025 14:36

fix(ruby): fix ProfileFetcher documentation

744c297

imobachgs marked this pull request as ready for review February 7, 2025 14:40

imobachgs added 3 commits February 7, 2025 14:44

docs: update changes files

9ee3b4a

Merge branch 'master' into profile-checker

a9e9dd7

fix(ruby): fix location of commands.rb

6795940

mvidner reviewed Feb 7, 2025

View reviewed changes

fix(ruby): add unit tests for the AgamaAutoYaST command

eb8ead1

mvidner reviewed Feb 7, 2025

View reviewed changes

fix(web): improve wording in the UnsupportedAutoYaST component

be389d4

Co-authored-by: Martin Vidner <mvidner@suse.cz>

docs: describe the autoyast.unsupported question

e5519e6

dgdavid approved these changes Feb 7, 2025

View reviewed changes

mvidner added 2 commits February 7, 2025 21:46

autoyast compat: declare "bootproto" unsupported

9044b34

and remove 'support: yes' from users[], it is implicit on all items with 'children'

Added JSON schema for autoyast-compat.json

3fefbf5

zypper install python3-jsonschema.rpm jsonschema -i autoyast-compat.json autoyast-compat.schema.json TODO: check in CI, maybe make `agama profile validate` a bit more generic

mvidner reviewed Feb 7, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: report unsupported AutoYaST elements #1976

feat: report unsupported AutoYaST elements #1976

imobachgs commented Feb 5, 2025 •

edited by mvidner

Loading

coveralls commented Feb 7, 2025

mvidner left a comment

mvidner commented Feb 7, 2025

mvidner Feb 7, 2025

mvidner Feb 7, 2025

imobachgs Feb 7, 2025

imobachgs commented Feb 7, 2025

imobachgs commented Feb 7, 2025

dgdavid left a comment

dgdavid commented Feb 7, 2025

mvidner Feb 7, 2025

This comment was marked as resolved.

mvidner commented Feb 10, 2025

This comment was marked as resolved.

This comment was marked as resolved.

feat: report unsupported AutoYaST elements #1976

Are you sure you want to change the base?

feat: report unsupported AutoYaST elements #1976

Conversation

imobachgs commented Feb 5, 2025 • edited by mvidner Loading

Problem

Solution

Generating the documentation

Disabling the check

Testing

Screenshots

To do

coveralls commented Feb 7, 2025

Pull Request Test Coverage Report for Build 13202155965

Details

💛 - Coveralls

mvidner left a comment

Choose a reason for hiding this comment

mvidner commented Feb 7, 2025

mvidner Feb 7, 2025

Choose a reason for hiding this comment

mvidner Feb 7, 2025

Choose a reason for hiding this comment

imobachgs Feb 7, 2025

Choose a reason for hiding this comment

imobachgs commented Feb 7, 2025

imobachgs commented Feb 7, 2025

dgdavid left a comment

Choose a reason for hiding this comment

dgdavid commented Feb 7, 2025

mvidner Feb 7, 2025

Choose a reason for hiding this comment

This comment was marked as resolved.

mvidner commented Feb 10, 2025

This comment was marked as resolved.

This comment was marked as resolved.

imobachgs commented Feb 5, 2025 •

edited by mvidner

Loading