Merge pull request #3 from oamg/upgrade-script

Init upgrade script

README.md

@@ -43,15 +43,18 @@ You can find official leapp_preupgrade_ansible.yaml for rhc-worker-playbook in p
 
 For rhc-worker-script we have only raw script leapp_preupgrade.py, signed version wrapped in yaml is still in development.
 
-### [WIP] Upgrade
+### Upgrade
 
-TBA
+**TBD** for rhc-worker-playbook.
+
+For rhc-worker-script we have only raw script leapp_upgrade.py, signed version wrapped in yaml is still in development.
 
 ## Local Development & Contributing
 
 ### Requirements
 
-* `virtualenv` - to run tests locally
+* `python2` - to run tests locally
+* `virtualenv` - `versions < 20.22.0` to run tests locally
 * `pre-commit` - to run checks before each commit, see hook in [.pre-commit-config.yml](./.pre-commit-config.yaml)
 * `make` - to use handy commands
 

schemas/upgrade_schema_1.0.json

@@ -0,0 +1,69 @@
+{
+    "title": "Leapp pre-upgrade script schema",
+    "description": "Script is expected to set up Leapp and run pre-upgrade analysis. This schema defines the output format that is expected by Red Hat Insights Task UI.",
+    "type": "object",
+    "properties": {
+      "alert": {
+        "type": "boolean"
+      },
+      "error": {
+        "type": "boolean"
+      },
+      "status": {
+        "$ref": "#/$defs/status_codes"
+      },
+      "report": {
+        "type": "string"
+      },
+      "message": {
+        "type": "string"
+      },
+      "report_json": {
+        "oneOf": [
+          {
+            "type": "null"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "entries": {
+                "type": "object"
+              },
+              "tasks_format_version": {
+                "type": "string"
+              },
+              "tasks_format_id": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "entries",
+              "tasks_format_version",
+              "tasks_format_id"
+            ]
+          }
+        ]
+      }
+    },
+    "required": [
+      "alert",
+      "error",
+      "status",
+      "message",
+      "report",
+      "report_json"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "status_codes": {
+        "description": "The severity of the results and messages",
+        "type": "string",
+        "enum": [
+          "SUCCESS",
+          "INFO",
+          "WARNING",
+          "ERROR"
+        ]
+      }
+    }
+  }