Add option to not generate directories for metadata and skip generati…

…on of md dir if fmf si nto generated (#35) Signed-off-by: Jakub Stejskal <[email protected]>
skodjob · Jun 27, 2024 · ad48363 · ad48363
1 parent ad7cc0d
commit ad48363
Show file tree

Hide file tree

Showing 31 changed files with 723 additions and 45 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,8 +2,10 @@
 **/target
 .DS_Store
 *.iml
-docs/fmf/
-docs/md/
+docs/actual/*/fmf/
+docs/actual/*/md/
+docs/actual/*/io/
+docs/actual/*/io*.md
 
 # Pom version backup
 **pom.xml.versionsBackup
diff --git a/docs/actual/option1/usecases/core+.md b/docs/actual/option1/usecases/core+.md
@@ -0,0 +1,5 @@
+# Core+
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option1/usecases/core.md b/docs/actual/option1/usecases/core.md
@@ -0,0 +1,5 @@
+# Core
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option2/usecases/core+.md b/docs/actual/option2/usecases/core+.md
@@ -0,0 +1,5 @@
+# Core+
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option2/usecases/core.md b/docs/actual/option2/usecases/core.md
@@ -0,0 +1,5 @@
+# Core
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option3/usecases/core+.md b/docs/actual/option3/usecases/core+.md
@@ -0,0 +1,5 @@
+# Core+
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option3/usecases/core.md b/docs/actual/option3/usecases/core.md
@@ -0,0 +1,5 @@
+# Core
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option4/usecases/core+.md b/docs/actual/option4/usecases/core+.md
@@ -0,0 +1,5 @@
+# Core+
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/actual/option4/usecases/core.md b/docs/actual/option4/usecases/core.md
@@ -0,0 +1,5 @@
+# Core
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
diff --git a/docs/expected/option1/fmf/io/skodjob/DummyTest.fmf b/docs/expected/option1/fmf/io/skodjob/DummyTest.fmf
@@ -0,0 +1,50 @@
+/testMethodFour:
+  summary: testMethodFour
+  contact: Jakub Stejskal <[email protected]>
+  description: |
+    Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+  tags:
+  - default
+  - regression
+
+/testMethodOne:
+  summary: testMethodOne
+  description: |
+    Test checking that the application works as expected
+  usecases:
+  - core
+  steps:
+  - result: Instance of an object is created
+    step: Create object instance
+  - result: Magic trick is done with success
+    step: Do a magic trick
+  - result: Everything is cleared
+    step: Clean up the test case
+  tags:
+  - default
+
+/testMethodThree:
+  summary: testMethodThree
+  contact: Jakub Stejskal <[email protected]>
+  description: |
+    Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+
+/testMethodTwo:
+  summary: testMethodTwo
+  contact: Jakub Stejskal <[email protected]>
+  description: |
+    Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+  usecases:
+  - core
+  - core+
+  - core+++
+  steps:
+  - result: Instance of an object is created
+    step: Create object instance
+  - result: Magic trick is done with success
+    step: Do a magic trick
+  - result: Everything is cleared
+    step: Clean up the test case
+  - result: Everything magically work
+    step: Do a magic cleanup check
+
diff --git a/docs/expected/option1/md/io/skodjob/DummyTest.md b/docs/expected/option1/md/io/skodjob/DummyTest.md
@@ -0,0 +1,90 @@
+# DummyTest
+
+**Description:** My test suite containing various tests
+
+**Before tests execution steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Deploy uber operator across all namespaces, with custom configuration | Uber operator is deployed |
+| 2. | Deploy management Pod for accessing all other Pods | Management Pod is deployed |
+
+**After tests execution steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Delete management Pod | Management Pod is deleted |
+| 2. | Delete uber operator | Uber operator is deleted |
+
+**Use-cases:**
+
+* `core`
+
+**Tags:**
+
+* `regression`
+* `clients`
+
+<hr style="border:1px solid">
+
+## testMethodFour
+
+**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+
+**Contact:** `Jakub Stejskal <[email protected]>`
+
+**Tags:**
+
+* `default`
+* `regression`
+
+
+## testMethodOne
+
+**Description:** Test checking that the application works as expected
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create object instance | Instance of an object is created |
+| 2. | Do a magic trick | Magic trick is done with success |
+| 3. | Clean up the test case | Everything is cleared |
+
+**Use-cases:**
+
+* `core`
+
+**Tags:**
+
+* `default`
+
+
+## testMethodThree
+
+**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+
+**Contact:** `Jakub Stejskal <[email protected]>`
+
+
+## testMethodTwo
+
+**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else.
+
+**Contact:** `Jakub Stejskal <[email protected]>`
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create object instance | Instance of an object is created |
+| 2. | Do a magic trick | Magic trick is done with success |
+| 3. | Clean up the test case | Everything is cleared |
+| 4. | Do a magic cleanup check | Everything magically work |
+
+**Use-cases:**
+
+* `core`
+* `core+`
+* `core+++`
+
diff --git a/docs/expected/option1/usecases/core+.md b/docs/expected/option1/usecases/core+.md
@@ -0,0 +1,9 @@
+# Core+
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
+
+<!-- generated part -->
+**Tests:**
+- [testMethodTwo](../../../.././docs/actual/option1/md/io/skodjob/DummyTest.md)
diff --git a/docs/expected/option1/usecases/core.md b/docs/expected/option1/usecases/core.md
@@ -0,0 +1,10 @@
+# Core
+
+**Description**: Suspendisse sagittis ultrices augue. Aenean vel massa quis mauris vehicula lacinia. Aliquam id dolor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed ac dolor sit amet purus malesuada congue. Aenean fermentum risus id tortor. Praesent in mauris eu tortor porttitor accumsan. Aliquam ante. Quisque porta. Duis condimentum augue id magna semper rutrum. Duis ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Duis risus.
+
+**Details**: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam justo enim, consectetuer nec, ullamcorper ac, vestibulum in, elit. Nullam feugiat, turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio risus sit amet ante. Sed vel lectus. Donec odio tempus molestie, porttitor ut, iaculis quis, sem. Nulla quis diam. Donec quis nibh at felis congue commodo. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Mauris elementum mauris vitae tortor. Praesent id justo in neque elementum ultrices. Vestibulum erat nulla, ullamcorper nec, rutrum non, nonummy ac, erat. Nullam faucibus mi quis velit. Donec iaculis gravida nulla. Etiam sapien elit, consequat eget, tristique non, venenatis quis, ante. Nulla turpis magna, cursus sit amet, suscipit a, interdum id, felis. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Integer lacinia.
+
+<!-- generated part -->
+**Tests:**
+- [testMethodTwo](../../../.././docs/actual/option1/md/io/skodjob/DummyTest.md)
+- [testMethodOne](../../../.././docs/actual/option1/md/io/skodjob/DummyTest.md)