add test that generated json from autoyast xml is valid by jreidinger · Pull Request #1946 · agama-project/agama

jreidinger · 2025-01-24T20:59:11Z

Problem

autoinst.xml profile conversion can lead to non valid profile.json

#1960
#1907
#1903

Solution

Add ci test to validate cloned autoyast profile. Fix issue with localization. Fix other autoyast conversion related issues.

Note: sadly I need to add python3-jsonschema to install as rubygem-json-schema does not support anything newer then draft5 json schema and we use newer.

Testing

Added a new unit test

Output

before pretty generate

{"localization":{"timezone":"America/New_York"},"product":{"id":"SLES"},"root":{"password":"$6$sxZ921ci.szwhCIw$9lrLQTtanJcpPeJkqv9pU0LsKQLO3RcPhBPBDMfc1uGUDCfgiyEyGPNr/ZKXAgqZsL61DANvr4uAYYDkif/Ma0","hashedPassword":true},"software":{"patterns":["apparmor","base","basic_desktop","enhanced_base","minimal_base","x11","x11_yast","yast2_basis"]},"legacyAutoyastStorage":[{"device":"/dev/system","enable_snapshots":true,"partitions":[{"create":true,"filesystem":"xfs","format":false,"lv_name":"home","mount":"/home","mountby":"device","pool":false,"resize":false,"size":"5792333824","stripes":1,"stripesize":0},{"create":true,"create_subvolumes":true,"filesystem":"btrfs","format":false,"lv_name":"root","mount":"/","mountby":"device","pool":false,"quotas":true,"resize":false,"size":"13522436096","stripes":1,"stripesize":0,"subvolumes":[{"copy_on_write":false,"path":"var"},{"copy_on_write":true,"path":"usr/local"},{"copy_on_write":true,"path":"tmp"},{"copy_on_write":true,"path":"srv"},{"copy_on_write":true,"path":"root"},{"copy_on_write":true,"path":"opt"},{"copy_on_write":true,"path":"boot/grub2/x86_64-efi"},{"copy_on_write":true,"path":"boot/grub2/i386-pc"}],"subvolumes_prefix":"@"},{"create":true,"filesystem":"swap","format":false,"lv_name":"swap","mount":"swap","mountby":"device","pool":false,"resize":false,"size":"2147483648","stripes":1,"stripesize":0}],"pesize":"4194304","type":"CT_LVM"},{"device":"/dev/sda","disklabel":"gpt","partitions":[{"create":true,"format":false,"partition_id":263,"partition_nr":1,"resize":false,"size":"8388608"},{"create":true,"format":false,"lvm_group":"system","partition_id":142,"partition_nr":2,"resize":false,"size":"21465382400"}],"type":"CT_DISK","use":"all"}],"user":{"userName":"tux","fullName":"tux","password":"$6$epM6.b193j7ZvUaw$/oMPS9pQR9X9i1MAJag20ZFy0XSI4985uVQDGLugwoCbDJVoXKCWLMFM.WncHr/bpkjecwb.LLaJeheYatq8f.","hashedPassword":true}}

after pretty generate

{
  "localization": {
    "timezone": "America/New_York"
  },
  "product": {
    "id": "SLES"
  },
  "root": {
    "password": "$6$sxZ921ci.szwhCIw$9lrLQTtanJcpPeJkqv9pU0LsKQLO3RcPhBPBDMfc1uGUDCfgiyEyGPNr/ZKXAgqZsL61DANvr4uAYYDkif/Ma0",
    "hashedPassword": true
  },
  "software": {
    "patterns": [
      "apparmor",
      "base",
      "basic_desktop",
      "enhanced_base",
      "minimal_base",
      "x11",
      "x11_yast",
      "yast2_basis"
    ]
  },
  "legacyAutoyastStorage": [
    {
      "device": "/dev/system",
      "enable_snapshots": true,
      "partitions": [
        {
          "create": true,
          "filesystem": "xfs",
          "format": false,
          "lv_name": "home",
          "mount": "/home",
          "mountby": "device",
          "pool": false,
          "resize": false,
          "size": "5792333824",
          "stripes": 1,
          "stripesize": 0
        },
        {
          "create": true,
          "create_subvolumes": true,
          "filesystem": "btrfs",
          "format": false,
          "lv_name": "root",
          "mount": "/",
          "mountby": "device",
          "pool": false,
          "quotas": true,
          "resize": false,
          "size": "13522436096",
          "stripes": 1,
          "stripesize": 0,
          "subvolumes": [
            {
              "copy_on_write": false,
              "path": "var"
            },
            {
              "copy_on_write": true,
              "path": "usr/local"
            },
            {
              "copy_on_write": true,
              "path": "tmp"
            },
            {
              "copy_on_write": true,
              "path": "srv"
            },
            {
              "copy_on_write": true,
              "path": "root"
            },
            {
              "copy_on_write": true,
              "path": "opt"
            },
            {
              "copy_on_write": true,
              "path": "boot/grub2/x86_64-efi"
            },
            {
              "copy_on_write": true,
              "path": "boot/grub2/i386-pc"
            }
          ],
          "subvolumes_prefix": "@"
        },
        {
          "create": true,
          "filesystem": "swap",
          "format": false,
          "lv_name": "swap",
          "mount": "swap",
          "mountby": "device",
          "pool": false,
          "resize": false,
          "size": "2147483648",
          "stripes": 1,
          "stripesize": 0
        }
      ],
      "pesize": "4194304",
      "type": "CT_LVM"
    },
    {
      "device": "/dev/sda",
      "disklabel": "gpt",
      "partitions": [
        {
          "create": true,
          "format": false,
          "partition_id": 263,
          "partition_nr": 1,
          "resize": false,
          "size": "8388608"
        },
        {
          "create": true,
          "format": false,
          "lvm_group": "system",
          "partition_id": 142,
          "partition_nr": 2,
          "resize": false,
          "size": "21465382400"
        }
      ],
      "type": "CT_DISK",
      "use": "all"
    }
  ],
  "user": {
    "userName": "tux",
    "fullName": "tux",
    "password": "$6$epM6.b193j7ZvUaw$/oMPS9pQR9X9i1MAJag20ZFy0XSI4985uVQDGLugwoCbDJVoXKCWLMFM.WncHr/bpkjecwb.LLaJeheYatq8f.",
    "hashedPassword": true
  }
}

…ilename is omitted it will be valid json and fix empty location tag(fix#1903)

…s://documentation.suse.com/sles/15-SP6/html/SLES-all/cha-configuration-installation-options.html#id-1.7.5.2.37.11.6 )

imobachgs

Just some minor comments. Otherwise, LGTM.

imobachgs · 2025-01-30T17:35:55Z

service/lib/agama/autoyast/scripts_reader.rb

      def read_script(section)
        script = {
-          "name" => section["file_name"]
+          "name" => section["filename"] || "annonymous#{@anonymous_counter += 1}"


typo: it should be anonymous but, to be honest, I do not like that prefix that much. I would prefer script-, or unnamed- or something else.

imobachgs · 2025-01-30T17:36:09Z

service/test/agama/autoyast/converter_test.rb

+  context "for cloned profile" do
+    let(:profile_name) { "cloned.xml" }
+
+    it "generate json according to schema" do


Suggested change

it "generate json according to schema" do

it "generate JSON according to schema" do

imobachgs · 2025-01-30T17:38:58Z

service/test/agama/autoyast/converter_test.rb

    end
  end
+
+  context "for cloned profile" do


It is just an AutoYaST profile, right? No matter whether it is cloned or written from scratch.

imobachgs · 2025-02-13T21:26:28Z

We refactored the converters when working on #1976, so this PR cannot be applied anymore. I have opened #1995 including your fixes (and some minor improvements). We could rework this one to add only the tests.

## Problem The conversion of the localization and scripts sections has several problems: - #1903 - #1907 - #1960 This PR include some changes from #1951 and #1946. ## Solution - Fix the handling of the scripts file name and location. - Fix the name of the localization setting ("localization" instead of "l10n"). Additionally, use "pretty" JSON when exporting the converted profile. ## Testing - _Added a new unit test_

jreidinger added 4 commits January 24, 2025 21:48

add test that generated json from autoyast xml is valid

369e6e2

fix deprecation warning

dceb4b4

fix name of localization section

af430b4

add to test also scripts. Fix typo in filename, ensure that even if f…

bc47b7f

…ilename is omitted it will be valid json and fix empty location tag(fix#1903)

jreidinger force-pushed the ci_autoinst_schema branch from 6eabbcd to 91bc0c3 Compare January 24, 2025 22:01

fix tests

91bc0c3

jreidinger force-pushed the ci_autoinst_schema branch from cbd6b5d to ff6bc66 Compare January 24, 2025 22:11

fix also in tests file_name typo ( see official documentation at http…

ff6bc66

…s://documentation.suse.com/sles/15-SP6/html/SLES-all/cha-configuration-installation-options.html#id-1.7.5.2.37.11.6 )

jreidinger mentioned this pull request Jan 30, 2025

fix(service): better handling of script names #1951

Closed

imobachgs reviewed Jan 30, 2025

View reviewed changes

imobachgs mentioned this pull request Feb 13, 2025

fix(ruby): fix localization and scripts conversion #1995

Merged

jreidinger closed this Feb 19, 2025

jreidinger deleted the ci_autoinst_schema branch February 19, 2025 09:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add test that generated json from autoyast xml is valid#1946

add test that generated json from autoyast xml is valid#1946
jreidinger wants to merge 6 commits intomasterfrom
ci_autoinst_schema

jreidinger commented Jan 24, 2025 •

edited

Loading

Uh oh!

imobachgs left a comment

Uh oh!

imobachgs Jan 30, 2025

Uh oh!

imobachgs Jan 30, 2025

Uh oh!

imobachgs Jan 30, 2025

Uh oh!

imobachgs commented Feb 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	it "generate json according to schema" do
	it "generate JSON according to schema" do

Conversation

jreidinger commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Testing

Output

Uh oh!

imobachgs left a comment

Choose a reason for hiding this comment

Uh oh!

imobachgs Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

imobachgs Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

imobachgs Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

imobachgs commented Feb 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jreidinger commented Jan 24, 2025 •

edited

Loading