class-generator: Update and add cluster schema API files (#2037)

* class-generator: update cluster schema files * class-generator: update cluster schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files * class-generator: update cluster schema files, add schema files
RedHatQE · Aug 15, 2024 · 202c2c1 · 202c2c1
1 parent 5f855a7
commit 202c2c1
Show file tree

Hide file tree

Showing 1,270 changed files with 376,379 additions and 2,678 deletions.
diff --git a/.flake8 b/.flake8
@@ -53,6 +53,8 @@ fcn_exclude_functions =
     tmp_path_factory,
     tmpdir_factory,
     Path,
+    writelines,
+    submit,
 
 enable-extensions =
     FCN,
diff --git a/.gitignore b/.gitignore
@@ -125,4 +125,4 @@ package.json
 package-lock.json
 
 # class generator script
-script/resource/debug/*
+class_generator/__ocp-openapi.json
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,5 @@
+exclude: "class_generator/schema/*"
+
 default_language_version:
   python: python3
 
@@ -30,8 +32,6 @@ repos:
     rev: v1.5.0
     hooks:
       - id: detect-secrets
-        args:
-          [--exclude-files=class_generator/tests/manifests/pod/pod_debug.json]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.5.7
@@ -54,4 +54,4 @@ repos:
     hooks:
       - id: mypy
         exclude: ^(tests/|examples/|docs/)
-        additional_dependencies: ["types-PyYAML"]
+        additional_dependencies: ["types-PyYAML", "types-requests"]
diff --git a/class_generator/README.md b/class_generator/README.md
@@ -1,14 +1,8 @@
 # Resource class generator
 
-## prerequisites
-
-- [poetry](https://python-poetry.org/)
-- [oc](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/) or [kubectl](https://kubernetes.io/docs/tasks/tools/) (latest version)
-- Kubernetes/Openshift cluster
-
 ## Usage
 
-###### Install poetry environment
+###### Installation
 
 - Using [pipx](https://github.com/pypa/pipx) (recommended)
 
@@ -25,6 +19,7 @@ python3 -m pip install openshift-python-wrapper
 - Using [poetry](https://python-poetry.org/) (For development)
 
 ```bash
+pipx install poetry
 poetry install
 ```
 
@@ -54,12 +49,6 @@ class-generator --kind <kind>
   - `OATH` -> `oath`
   - `CDIConfig` -> `cdi_config`
 
-Run in interactive mode:
-
-```bash
-class-generator --interactive
-```
-
 #### Adding tests
 
 - Add a new test for the provided `kind` by passing `--add-tests` flag
@@ -69,6 +58,44 @@ class-generator --interactive
 class-generator --kind Pod --add-tests
 ```
 
+#### Update schema files
+
+- Dependencies
+  - Kubernetes/Openshift cluster
+  - [oc](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/) or [kubectl](https://kubernetes.io/docs/tasks/tools/) (latest version)
+  - [openapi2jsonschema](https://github.com/instrumenta/openapi2jsonschema)
+  - [poetry](https://python-poetry.org/)
+
+```bash
+pipx install poetry
+pipx install --python python3.9 openapi2jsonschema
+```
+
+- Clone this repository
+
+```bash
+got clone https://github.com/RedHatQE/openshift-python-wrapper.git
+cd openshift-python-wrapper
+```
+
+- Install dependencies
+
+```bash
+poetry install
+```
+
+- Login to the cluster use admin user and password.
+
+```bash
+oc login <clster api URL> -u <username> -p <password>
+```
+
+- Execute the command:
+
+```bash
+poetry run python class_generator/class-generator --update-schema
+```
+
 ## Reporting an issue
 
 - Running with debug mode and `--debug` flag: