From ad48363584674cc31d25afbee1e9e5a547a9045b Mon Sep 17 00:00:00 2001 From: Jakub Stejskal Date: Thu, 27 Jun 2024 19:05:13 +0200 Subject: [PATCH] Add option to not generate directories for metadata and skip generation of md dir if fmf si nto generated (#35) Signed-off-by: Jakub Stejskal --- .gitignore | 6 +- docs/actual/option1/usecases/core+.md | 5 ++ docs/actual/option1/usecases/core.md | 5 ++ docs/actual/option2/usecases/core+.md | 5 ++ docs/actual/option2/usecases/core.md | 5 ++ docs/actual/option3/usecases/core+.md | 5 ++ docs/actual/option3/usecases/core.md | 5 ++ docs/actual/option4/usecases/core+.md | 5 ++ docs/actual/option4/usecases/core.md | 5 ++ .../option1/fmf/io/skodjob/DummyTest.fmf | 50 +++++++++++ .../option1/md/io/skodjob/DummyTest.md | 90 +++++++++++++++++++ docs/expected/option1/usecases/core+.md | 9 ++ docs/expected/option1/usecases/core.md | 10 +++ .../option2/fmf/io.skodjob.DummyTest.fmf | 50 +++++++++++ .../option2/md/io.skodjob.DummyTest.md | 90 +++++++++++++++++++ docs/expected/option2/usecases/core+.md | 9 ++ docs/expected/option2/usecases/core.md | 10 +++ docs/expected/option3/io.skodjob.DummyTest.md | 90 +++++++++++++++++++ docs/expected/option3/usecases/core+.md | 9 ++ docs/expected/option3/usecases/core.md | 10 +++ docs/expected/option4/io/skodjob/DummyTest.md | 90 +++++++++++++++++++ docs/expected/option4/usecases/core+.md | 9 ++ docs/expected/option4/usecases/core.md | 10 +++ docs/usecases/core+.md | 4 + docs/usecases/core.md | 3 + dummy-module/pom.xml | 51 +++++++++-- scripts/check-docs.sh | 79 +++++++++++----- test-docs-generator-maven-plugin/pom.xml | 4 +- .../java/io/skodjob/DocGeneratorMojo.java | 17 +++- .../src/main/java/io/skodjob/MdGenerator.java | 8 +- .../main/java/io/skodjob/common/Utils.java | 20 +++-- 31 files changed, 723 insertions(+), 45 deletions(-) create mode 100644 docs/actual/option1/usecases/core+.md create mode 100644 docs/actual/option1/usecases/core.md create mode 100644 docs/actual/option2/usecases/core+.md create mode 100644 docs/actual/option2/usecases/core.md create mode 100644 docs/actual/option3/usecases/core+.md create mode 100644 docs/actual/option3/usecases/core.md create mode 100644 docs/actual/option4/usecases/core+.md create mode 100644 docs/actual/option4/usecases/core.md create mode 100644 docs/expected/option1/fmf/io/skodjob/DummyTest.fmf create mode 100644 docs/expected/option1/md/io/skodjob/DummyTest.md create mode 100644 docs/expected/option1/usecases/core+.md create mode 100644 docs/expected/option1/usecases/core.md create mode 100644 docs/expected/option2/fmf/io.skodjob.DummyTest.fmf create mode 100644 docs/expected/option2/md/io.skodjob.DummyTest.md create mode 100644 docs/expected/option2/usecases/core+.md create mode 100644 docs/expected/option2/usecases/core.md create mode 100644 docs/expected/option3/io.skodjob.DummyTest.md create mode 100644 docs/expected/option3/usecases/core+.md create mode 100644 docs/expected/option3/usecases/core.md create mode 100644 docs/expected/option4/io/skodjob/DummyTest.md create mode 100644 docs/expected/option4/usecases/core+.md create mode 100644 docs/expected/option4/usecases/core.md diff --git a/.gitignore b/.gitignore index 10b5a43..a38f711 100644 --- 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 new file mode 100644 index 0000000..3ad9893 --- /dev/null +++ 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 new file mode 100644 index 0000000..32a8428 --- /dev/null +++ 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 new file mode 100644 index 0000000..3ad9893 --- /dev/null +++ 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 new file mode 100644 index 0000000..32a8428 --- /dev/null +++ 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 new file mode 100644 index 0000000..3ad9893 --- /dev/null +++ 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 new file mode 100644 index 0000000..32a8428 --- /dev/null +++ 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 new file mode 100644 index 0000000..3ad9893 --- /dev/null +++ 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 new file mode 100644 index 0000000..32a8428 --- /dev/null +++ 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 new file mode 100644 index 0000000..4a15d34 --- /dev/null +++ b/docs/expected/option1/fmf/io/skodjob/DummyTest.fmf @@ -0,0 +1,50 @@ +/testMethodFour: + summary: testMethodFour + contact: Jakub Stejskal + 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 + 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 + 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 new file mode 100644 index 0000000..256ddd7 --- /dev/null +++ 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` + +
+ +## testMethodFour + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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 ` + + +## testMethodTwo + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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 new file mode 100644 index 0000000..ff59c9b --- /dev/null +++ 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. + + +**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 new file mode 100644 index 0000000..dfec848 --- /dev/null +++ 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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option1/md/io/skodjob/DummyTest.md) +- [testMethodOne](../../../.././docs/actual/option1/md/io/skodjob/DummyTest.md) diff --git a/docs/expected/option2/fmf/io.skodjob.DummyTest.fmf b/docs/expected/option2/fmf/io.skodjob.DummyTest.fmf new file mode 100644 index 0000000..4a15d34 --- /dev/null +++ b/docs/expected/option2/fmf/io.skodjob.DummyTest.fmf @@ -0,0 +1,50 @@ +/testMethodFour: + summary: testMethodFour + contact: Jakub Stejskal + 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 + 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 + 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/option2/md/io.skodjob.DummyTest.md b/docs/expected/option2/md/io.skodjob.DummyTest.md new file mode 100644 index 0000000..256ddd7 --- /dev/null +++ b/docs/expected/option2/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` + +
+ +## testMethodFour + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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 ` + + +## testMethodTwo + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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/option2/usecases/core+.md b/docs/expected/option2/usecases/core+.md new file mode 100644 index 0000000..575fa0c --- /dev/null +++ b/docs/expected/option2/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option2/md/io.skodjob.DummyTest.md) diff --git a/docs/expected/option2/usecases/core.md b/docs/expected/option2/usecases/core.md new file mode 100644 index 0000000..fcf11e5 --- /dev/null +++ b/docs/expected/option2/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option2/md/io.skodjob.DummyTest.md) +- [testMethodOne](../../../.././docs/actual/option2/md/io.skodjob.DummyTest.md) diff --git a/docs/expected/option3/io.skodjob.DummyTest.md b/docs/expected/option3/io.skodjob.DummyTest.md new file mode 100644 index 0000000..256ddd7 --- /dev/null +++ b/docs/expected/option3/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` + +
+ +## testMethodFour + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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 ` + + +## testMethodTwo + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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/option3/usecases/core+.md b/docs/expected/option3/usecases/core+.md new file mode 100644 index 0000000..f29f2fc --- /dev/null +++ b/docs/expected/option3/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option3/io.skodjob.DummyTest.md) diff --git a/docs/expected/option3/usecases/core.md b/docs/expected/option3/usecases/core.md new file mode 100644 index 0000000..1fcbcc7 --- /dev/null +++ b/docs/expected/option3/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option3/io.skodjob.DummyTest.md) +- [testMethodOne](../../../.././docs/actual/option3/io.skodjob.DummyTest.md) diff --git a/docs/expected/option4/io/skodjob/DummyTest.md b/docs/expected/option4/io/skodjob/DummyTest.md new file mode 100644 index 0000000..256ddd7 --- /dev/null +++ b/docs/expected/option4/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` + +
+ +## testMethodFour + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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 ` + + +## testMethodTwo + +**Description:** Test checking that the application works as expected. This is just a little bit longer line, nothing else. + +**Contact:** `Jakub Stejskal ` + +**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/option4/usecases/core+.md b/docs/expected/option4/usecases/core+.md new file mode 100644 index 0000000..ab9b4e6 --- /dev/null +++ b/docs/expected/option4/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option4/io/skodjob/DummyTest.md) diff --git a/docs/expected/option4/usecases/core.md b/docs/expected/option4/usecases/core.md new file mode 100644 index 0000000..bfde278 --- /dev/null +++ b/docs/expected/option4/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. + + +**Tests:** +- [testMethodTwo](../../../.././docs/actual/option4/io/skodjob/DummyTest.md) +- [testMethodOne](../../../.././docs/actual/option4/io/skodjob/DummyTest.md) diff --git a/docs/usecases/core+.md b/docs/usecases/core+.md index 3ad9893..45803f8 100644 --- a/docs/usecases/core+.md +++ b/docs/usecases/core+.md @@ -3,3 +3,7 @@ **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. + + +**Tests:** +- [testMethodTwo](../.././docs/md/io/skodjob/DummyTest.md) diff --git a/docs/usecases/core.md b/docs/usecases/core.md index b4e5b2a..7481ea3 100644 --- a/docs/usecases/core.md +++ b/docs/usecases/core.md @@ -5,3 +5,6 @@ **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. +**Tests:** +- [testMethodTwo](../.././docs/md/io/skodjob/DummyTest.md) +- [testMethodOne](../.././docs/md/io/skodjob/DummyTest.md) diff --git a/dummy-module/pom.xml b/dummy-module/pom.xml index 9b556d6..782af93 100644 --- a/dummy-module/pom.xml +++ b/dummy-module/pom.xml @@ -93,17 +93,58 @@ ${project.parent.version} + option1 post-integration-test test-docs-generator + + ./dummy-module/src/test/java/io/skodjob/ + ./docs/actual/option1/ + true + true + + + + option2 + post-integration-test + + test-docs-generator + + + ./dummy-module/src/test/java/io/skodjob/ + ./docs/actual/option2/ + true + false + + + + option3 + post-integration-test + + test-docs-generator + + + ./dummy-module/src/test/java/io/skodjob/ + ./docs/actual/option3/ + false + false + + + + option4 + post-integration-test + + test-docs-generator + + + ./dummy-module/src/test/java/io/skodjob/ + ./docs/actual/option4/ + false + true + - - ./dummy-module/src/test/java/io/skodjob/ - ./docs/ - true - exec-maven-plugin diff --git a/scripts/check-docs.sh b/scripts/check-docs.sh index fdaa9ab..9b8678a 100755 --- a/scripts/check-docs.sh +++ b/scripts/check-docs.sh @@ -1,25 +1,58 @@ #!/usr/bin/env bash -DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" - -fmf_output="${DIR}/../docs/fmf/io/skodjob/DummyTest.fmf" -fmf_expected="${DIR}/../test-docs-generator-maven-plugin/src/test/resources/expected-docs.fmf" - -md_output="${DIR}/../docs/md/io/skodjob/DummyTest.md" -md_expected="${DIR}/../test-docs-generator-maven-plugin/src/test/resources/expected-docs.md" - -if cmp -s "$fmf_output" "$fmf_expected"; then - echo "The files \"$fmf_output\" and \"$fmf_expected\" are the same." -else - echo "The files \"$fmf_output\" and \"$fmf_expected\" are different." - diff "$fmf_output" "$fmf_expected" - exit 1 -fi - -if cmp -s "$md_output" "$md_expected"; then - echo "The files \"$md_output\" and \"$md_expected\" are the same." -else - echo "The files \"$md_output\" and \"$md_expected\" are different." - diff "$md_output" "$md_expected" - exit 1 -fi +# Function to compare two files +compare_files() { + file1=$1 + file2=$2 + + if cmp -s "$file1" "$file2"; then + echo "Files $file1 and $file2 are identical." + else + echo "Files $file1 and $file2 differ." + diff "$file1" "$file2" + exit 1 + fi +} + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" + +# Base directories +CURRENT_DIR="$SCRIPT_DIR/../docs" +EXPECTED_DIR="$CURRENT_DIR/expected" +ACTUAL_DIR="$CURRENT_DIR/actual" + +USECASE1="usecases/core+.md" +USECASE2="usecases/core.md" + +OPTION_1="option1" +OPTION_1_MD="md/io/skodjob/DummyTest.md" +OPTION_1_FMF="fmf/io/skodjob/DummyTest.fmf" + +OPTION_2="option2" +OPTION_2_MD="md/io.skodjob.DummyTest.md" +OPTION_2_FMF="fmf/io.skodjob.DummyTest.fmf" + +OPTION_3="option3" +OPTION_3_MD="io.skodjob.DummyTest.md" + +OPTION_4="option4" +OPTION_4_MD="io/skodjob/DummyTest.md" + +compare_files "$ACTUAL_DIR/$OPTION_1/$OPTION_1_MD" "$EXPECTED_DIR/$OPTION_1/$OPTION_1_MD" +compare_files "$ACTUAL_DIR/$OPTION_1/$OPTION_1_FMF" "$EXPECTED_DIR/$OPTION_1/$OPTION_1_FMF" +compare_files "$ACTUAL_DIR/$OPTION_1/$USECASE1" "$EXPECTED_DIR/$OPTION_1/$USECASE1" +compare_files "$ACTUAL_DIR/$OPTION_1/$USECASE2" "$EXPECTED_DIR/$OPTION_1/$USECASE2" + +compare_files "$ACTUAL_DIR/$OPTION_2/$OPTION_2_MD" "$EXPECTED_DIR/$OPTION_2/$OPTION_2_MD" +compare_files "$ACTUAL_DIR/$OPTION_2/$OPTION_2_FMF" "$EXPECTED_DIR/$OPTION_2/$OPTION_2_FMF" +compare_files "$ACTUAL_DIR/$OPTION_2/$USECASE1" "$EXPECTED_DIR/$OPTION_2/$USECASE1" +compare_files "$ACTUAL_DIR/$OPTION_2/$USECASE2" "$EXPECTED_DIR/$OPTION_2/$USECASE2" + +compare_files "$ACTUAL_DIR/$OPTION_3/$OPTION_3_MD" "$EXPECTED_DIR/$OPTION_3/$OPTION_3_MD" +compare_files "$ACTUAL_DIR/$OPTION_3/$USECASE1" "$EXPECTED_DIR/$OPTION_3/$USECASE1" +compare_files "$ACTUAL_DIR/$OPTION_3/$USECASE2" "$EXPECTED_DIR/$OPTION_3/$USECASE2" + +compare_files "$ACTUAL_DIR/$OPTION_4/$OPTION_4_MD" "$EXPECTED_DIR/$OPTION_4/$OPTION_4_MD" +compare_files "$ACTUAL_DIR/$OPTION_4/$USECASE1" "$EXPECTED_DIR/$OPTION_4/$USECASE1" +compare_files "$ACTUAL_DIR/$OPTION_4/$USECASE2" "$EXPECTED_DIR/$OPTION_4/$USECASE2" + diff --git a/test-docs-generator-maven-plugin/pom.xml b/test-docs-generator-maven-plugin/pom.xml index 2c09432..2dd3927 100644 --- a/test-docs-generator-maven-plugin/pom.xml +++ b/test-docs-generator-maven-plugin/pom.xml @@ -59,14 +59,14 @@ 17 UTF-8 - 5.8.2 + 5.10.2 3.9.3 3.9.0 2.2.1 2.2 5.10.2 1.10.2 - 3.1.2 + 3.3.0 2.2 diff --git a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/DocGeneratorMojo.java b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/DocGeneratorMojo.java index f0fba9a..b298a20 100644 --- a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/DocGeneratorMojo.java +++ b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/DocGeneratorMojo.java @@ -50,6 +50,12 @@ public DocGeneratorMojo() { @Parameter(property = "docsPath", defaultValue = "./test-docs", required = true, readonly = false) String docsPath; + /** + * Whether it should generate subfolders for packages or not + */ + @Parameter(property = "generateDirs", defaultValue = "false", required = false, readonly = false) + boolean generateDirs; + /** * Option for generating fmf */ @@ -102,17 +108,20 @@ public void execute() { getLog().debug(url.getFile()); } - Map classes = Utils.getTestClassesWithTheirPath(testsPath); - + Map classes = Utils.getTestClassesWithTheirPath(testsPath, generateDirs); for (Map.Entry entry : classes.entrySet()) { try { Class testClass = classRealm.loadClass(entry.getValue()); - MdGenerator.generate(testClass, docsPath + "md/" + entry.getKey() + ".md"); + // In case user don't want to generate fmf, the md file won't be in md folder + String mdDirectoryName = ""; if (generateFmf) { + // Add md folder to the path + mdDirectoryName = "md/"; FmfGenerator.generate(testClass, docsPath + "fmf/" + entry.getKey() + ".fmf"); } else { - getLog().info("Skipping fmf generation"); + getLog().debug("Skipping fmf generation"); } + MdGenerator.generate(testClass, docsPath + mdDirectoryName + entry.getKey() + ".md"); } catch (ClassNotFoundException | IOException ex) { getLog().warn(String.format("Cannot load %s", entry.getValue())); diff --git a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/MdGenerator.java b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/MdGenerator.java index 16f9d48..68a699f 100644 --- a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/MdGenerator.java +++ b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/MdGenerator.java @@ -281,7 +281,7 @@ private static void updateUsecaseFile(String usecaseFilePath, String updatedData try (BufferedWriter writer = new BufferedWriter(new FileWriter(markdownFile))) { writer.write(fileContent.toString()); } - System.out.println("Content updated successfully!"); + System.out.println("Content of %s updated successfully!".formatted(usecaseFilePath)); } catch (IOException e) { e.printStackTrace(); @@ -294,6 +294,10 @@ private static void updateUsecaseFile(String usecaseFilePath, String updatedData */ public static void updateLinksInUsecases(String docsPath) { String usecasesPath = docsPath + USECASES_PATH; + + int numberOfDirs = docsPath.length() - docsPath.replace("/", "").length(); + String mdFilesPath = "../".repeat(numberOfDirs); + if (Files.exists(new File(usecasesPath).toPath())) { for (Map.Entry> entry : MdGenerator.usecasesMap.entrySet()) { String usecasesFile = usecasesPath + "/" + entry.getKey() + ".md"; @@ -301,7 +305,7 @@ public static void updateLinksInUsecases(String docsPath) { if (Files.exists(new File(usecasesFile).toPath())) { StringBuilder newText = new StringBuilder("**Tests:**"); for (Map.Entry item: entry.getValue().entrySet()) { - String data = String.format("[%s](../../%s)", item.getKey(), item.getValue()); + String data = String.format("[%s](%s%s)", item.getKey(), mdFilesPath, item.getValue()); newText.append("\n- ").append(data); } diff --git a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/common/Utils.java b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/common/Utils.java index fdd3c9d..b668ba6 100644 --- a/test-docs-generator-maven-plugin/src/main/java/io/skodjob/common/Utils.java +++ b/test-docs-generator-maven-plugin/src/main/java/io/skodjob/common/Utils.java @@ -44,17 +44,21 @@ private Utils() { * @param packagePath path on which the files and classes should be listed * @return updated Map with test-classes info from the {@param packagePath} */ - private static Map getClassesForPackage(Map classes, Path packagePath) { + private static Map getClassesForPackage(Map classes, Path packagePath, boolean generateDirs) { if (Files.isDirectory(packagePath)) { try (Stream pathStream = Files.list(packagePath)) { - pathStream.forEach(path -> classes.putAll(getClassesForPackage(classes, path))); + pathStream.forEach(path -> classes.putAll(getClassesForPackage(classes, path, generateDirs))); } catch (IOException e) { e.printStackTrace(); throw new RuntimeException(e); } } else { String classPackagePath = packagePath.toAbsolutePath().toString().replaceAll(REMOVE_BEFORE_PACKAGE.toString(), "").replace(".java", ""); - classes.put(classPackagePath, classPackagePath.replaceAll("/", ".")); + String filename = classPackagePath; + if (!generateDirs) { + filename = filename.replaceAll("/", "."); + } + classes.put(filename, classPackagePath.replaceAll("/", ".")); } return classes; @@ -66,13 +70,14 @@ private static Map getClassesForPackage(Map clas * on classpath * Also excludes files that should not be considered for documentation (currently just "AbstractST") * @param filePath path where are all test-classes present + * @param generateDirs whether it should generate subfolders for packages or not * @return Map with test-classes info from the {@param filePath} */ - public static Map getTestClassesWithTheirPath(String filePath) { + public static Map getTestClassesWithTheirPath(String filePath, boolean generateDirs) { Map classes = new HashMap<>(); try (Stream pathStream = Files.list(Paths.get(filePath))) { - pathStream.forEach(path -> classes.putAll(getClassesForPackage(classes, path))); + pathStream.forEach(path -> classes.putAll(getClassesForPackage(classes, path, generateDirs))); } catch (IOException exception) { throw new RuntimeException(exception); } @@ -91,9 +96,10 @@ public static PrintWriter createFilesForTestClass(String classFilePath) throws I String parentPath = classFilePath.replace(fileName, ""); final File parent = new File(parentPath); - if (!parent.mkdirs()) { - System.err.println("Could not create parent directories "); + if (!parent.exists()) { + parent.mkdirs(); } + final File classFile = new File(parent, fileName); classFile.createNewFile();