Doc Automation: Command Reference: odo init #6442
Conversation
✅ Deploy Preview for odo-docusaurus-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
3538d42 to
466431e
Compare
466431e to
c32e3bb
Compare
There was a problem hiding this comment.
Great work @valaparthvi
Just a few comment, to try and make it more maintainable
tests/documentation/command-reference/doc_command_reference_init_test.go
Outdated
Show resolved
Hide resolved
tests/documentation/command-reference/doc_command_reference_init_test.go
Outdated
Show resolved
Hide resolved
tests/documentation/command-reference/doc_command_reference_init_test.go
Outdated
Show resolved
Hide resolved
| helper.SetDefaultDevfileRegistryAsStaging() | ||
| }) | ||
|
|
||
| removePreferenceKeys := func(docString string) (returnString string) { |
There was a problem hiding this comment.
This seems too much specific to me. It would be nice to have a mechanism to have [...] in the MDX file match any number of lines in the output, so thsi could be reused for other tests
There was a problem hiding this comment.
I had a similar thought, but there aren't many mdx/md files at present that use [...], so I decide to be more specific. I would prefer to iterate over this when the need arises.
There was a problem hiding this comment.
@valaparthvi I'm trying to run the Make target, but no Spec ran. Am I missing something?
$ make test-doc-automation
go run -mod=vendor github.com/onsi/ginkgo/v2/ginkgo --junit-report=.tmp/junit-report.xml --randomize-all --slow-spec-threshold=120s -timeout 14400s --no-color -nodes=8 --junit-report="test-doc-automation.xml" tests/documentation
=== RUN TestDocAutomation
Running Suite: Doc Automation Suite - /home/asoro/work/projects/odo/tests/documentation
=======================================================================================
Random Seed: 1672759310
Will run 0 of 0 specs
Ran 0 of 0 Specs in 0.000 seconds
SUCCESS! -- 0 Passed | 0 Failed | 0 Pending | 0 Skipped
--- PASS: TestDocAutomation (0.00s)
PASS
Ginkgo ran 1 suite in 5.359164652s
Test Suite Passed
No, you're right. I have attempted to fix it, please try it again. |
14721f0 to
9d184ea
Compare
👍🏿 It works better now - thanks! |
|
/override OpenShift-Integration-tests/OpenShift-Integration-tests |
|
@valaparthvi: Overrode contexts on behalf of valaparthvi: OpenShift-Integration-tests/OpenShift-Integration-tests In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
tests/documentation/command-reference/doc_command_reference_init_test.go
Show resolved
Hide resolved
| __ | ||
| / \__ Initializing a new component | ||
| \__/ \ | ||
| / \__/ odo version: v3.4.0 |
There was a problem hiding this comment.
The test fails when I rebase the branch after bump to 3.5.0.
Could we find a way to include the build/VERSION file in the doc, and proccess the mdx file to resolve the include, before to compare it?
There was a problem hiding this comment.
Oh, you're right! Let me see what can be done.
There was a problem hiding this comment.
Discussed in standup, we will manually update the docs right now if they fail. For version, we can update GH action to update it with every release.
Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
…r doc automation tests; add documentation for helper functions Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
for tests with specific check Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
…e or let it be Signed-off-by: Parthvi Vala <pvala@redhat.com>
…s flaky Signed-off-by: Parthvi Vala <pvala@redhat.com>
935dbb1 to
a7dd858
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
What type of PR is this:
/kind tests
/area documentation
What does this PR do / why we need it:
Which issue(s) this PR fixes:
Fixes #6465
Fixes #6468
PR acceptance criteria:
Unit test
Integration test
Documentation
How to test changes / Special notes to the reviewer: