[WIP] Expand example to include schemas

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>

examples/plugins/discover.py → examples/plugins/example/discover.py

@@ -1,11 +1,23 @@
+import dataclasses
+
 import tmt
 import tmt.steps
 import tmt.steps.discover
+import tmt.utils
 
 # See the online documentation for more details about writing plugins
 # https://tmt.readthedocs.io/en/stable/plugins.html
 
 
+@dataclasses.dataclass
+class DiscoverExampleData(tmt.steps.discover.DiscoverStepData):
+    path: str = tmt.utils.field(
+        default=".",
+        option=('-p', '--path'),
+        metavar='ROOT',
+        help='Path to the metadata tree root.')
+
+
 @tmt.steps.provides_method('example')
 class DiscoverExample(tmt.steps.discover.DiscoverPlugin):
     """
@@ -16,6 +28,8 @@ class DiscoverExample(tmt.steps.discover.DiscoverPlugin):
     of configuration examples as well.
     """
 
+    _data_class = DiscoverExampleData
+
     def show(self):
         """ Show plugin details for given or all available keys """
         super().show([])
@@ -48,7 +62,8 @@ def go(self):
         print("Code should prepare environment for tests.")
 
         # Discover available tests
-        self._tests = tmt.Tree(logger=self._logger, path=".").tests()
+        self._tests = tmt.Tree(logger=self._logger,
+                               path=self.data.path).tests()
 
     def tests(self):
         """

examples/plugins/provision.py → examples/plugins/example/provision.py

@@ -46,7 +46,7 @@ def default(self, option, default=None):
         defaults = {
             'what': 'default value',
             'switch': False,
-            }
+        }
         return defaults.get(option, default)
 
     def show(self):

examples/plugins/example/schemas/discover/example.yaml

@@ -0,0 +1,23 @@
+$id: /schemas/discover/example
+$schema: https://json-schema.org/draft-07/schema
+
+type: object
+additionalProperties: false
+
+properties:
+
+  how:
+    type: string
+    enum:
+      - example
+  path:
+    $ref: "/schemas/common#/definitions/fmf_id/properties/path"
+
+  # Other basic discover properties
+  name:
+    type: string
+  order:
+    $ref: "/schemas/core#/definitions/order"
+
+required:
+  - how

examples/plugins/pyproject.toml

@@ -6,11 +6,13 @@ dependencies = [
     ]
 
 [tool.setuptools]
-py-modules = [
-    "discover",
-    "provision",
+packages = [
+    "example",
 ]
 
 [project.entry-points."tmt.plugin"]
-ProvisionExample = "provision:ProvisionExample"
-DiscoverExample = "discover:DiscoverExample"
+ProvisionExample = "example.provision:ProvisionExample"
+DiscoverExample = "example.discover:DiscoverExample"
+
+[project.entry-points."tmt.resources"]
+ResourcesExample = "examaple"