Automate Doc: Quickstart Guides

[valaparthvi]

Signed-off-by: Parthvi Vala pvala@redhat.com

What type of PR is this:
/kind tests
/area documentation

What does this PR do / why we need it:
This PR adds tests to verify quickstart doc outputs.

Which issue(s) this PR fixes:

Fixes #6466

PR acceptance criteria:

• Unit test

• Integration test

• Documentation

How to test changes / Special notes to the reviewer:

[netlify]

✅ Deploy Preview for odo-docusaurus-preview canceled.

Name	Link
🔨 Latest commit	6f223b7
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/63b82a838742f40008d4e028

[odo-robot]

NoCluster Tests on commit bde10e3 finished successfully.
View logs: TXT HTML

[odo-robot]

OpenShift Tests on commit bde10e3 finished with errors.
View logs: TXT HTML

[odo-robot]

Unit Tests on commit bde10e3 finished successfully.
View logs: TXT HTML

[odo-robot]

Validate Tests on commit bde10e3 finished successfully.
View logs: TXT HTML

[odo-robot]

Kubernetes Tests on commit bde10e3 finished successfully.
View logs: TXT HTML

[odo-robot]

Windows Tests (OCP) on commit bde10e3 finished successfully.
View logs: TXT HTML

[feloy]

@valaparthvi When running the tests locally, with a Kubernetes cluster, I get the following error. Do you get it too?

Expected
      <string>:   (
        	"""
        	... // 11 identical lines
        	✓  Pod is Running
        	✓  Syncing files into the container [1s]
      + 	cat: /opt/odo/.odo_cmd_run.pid: No such file or directory
        	✓  Building your application in container on cluster (command: build) [1s]
        	•  Executing the application (command: run)  ...
      + 	196
      + 	0
      + 	196
      + 	0
        	-  Forwarding from 127.0.0.1:40001 -> 8080
        	
        	... // 11 identical lines
        	"""
        )
      
  to be empty

[valaparthvi]

@valaparthvi When running the tests locally, with a Kubernetes cluster, I get the following error. Do you get it too?

Expected
      <string>:   (
        	"""
        	... // 11 identical lines
        	✓  Pod is Running
        	✓  Syncing files into the container [1s]
      + 	cat: /opt/odo/.odo_cmd_run.pid: No such file or directory
        	✓  Building your application in container on cluster (command: build) [1s]
        	•  Executing the application (command: run)  ...
      + 	196
      + 	0
      + 	196
      + 	0
        	-  Forwarding from 127.0.0.1:40001 -> 8080
        	
        	... // 11 identical lines
        	"""
        )
      
  to be empty

I didn't encounter it while working on the tests, I'll re-run the tests though.

[valaparthvi]

@valaparthvi When running the tests locally, with a Kubernetes cluster, I get the following error. Do you get it too?

Expected
      <string>:   (
        	"""
        	... // 11 identical lines
        	✓  Pod is Running
        	✓  Syncing files into the container [1s]
      + 	cat: /opt/odo/.odo_cmd_run.pid: No such file or directory
        	✓  Building your application in container on cluster (command: build) [1s]
        	•  Executing the application (command: run)  ...
      + 	196
      + 	0
      + 	196
      + 	0
        	-  Forwarding from 127.0.0.1:40001 -> 8080
        	
        	... // 11 identical lines
        	"""
        )
      
  to be empty

I didn't encounter it while working on the tests, I'll re-run the tests though.

I can see them now. I'll try to skip those.

[feloy]

@valaparthvi This PR should remove the unwanted output: #6473
Feel free to integrate the change in your PR

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.4% Duplication

[valaparthvi]

/override OpenShift-Integration-tests/OpenShift-Integration-tests

I am overriding the test for now because the failure is unrelated to the changes made here, but the following failure needs to be investigated:

Expected
      <string>:   __
       /  \__     Developing using the "xpczcj" Devfile
       \__/  \    Namespace: cmd-logs-test189tbj
       /  \__/    odo version: v3.5.0
       \__/
      
      ↪ Deploying to the cluster in developer mode
       •  Waiting for Kubernetes resources  ...
       •  Creating resource Pod/myapp-inner  ...
      
 ✓  Creating resource Pod/myapp-inner 
       âš   Pod is Pending
       ✓  Pod is Running
       •  Deleting resources not present in the Devfile: PodMetrics/myapp-inner  ...
      
 ✓  Deleting resources not present in the Devfile: PodMetrics/myapp-inner [1s]
      Error occurred on Push - watch command was unable to push component: unable to delete remote resources: unable to delete resource: PodMetrics/myapp-inner: the server does not allow this method on the requested resource
      
       •  Deleting resources not present in the Devfile: PodMetrics/myapp-inner  ...
      
 ✓  Deleting resources not present in the Devfile: PodMetrics/myapp-inner [1s]
      Error occurred on Push - watch command was unable to push component: unable to delete remote resources: unable to delete resource: PodMetrics/myapp-inner: the server does not allow this method on the requested resource

[openshift-ci]

@valaparthvi: Overrode contexts on behalf of valaparthvi: OpenShift-Integration-tests/OpenShift-Integration-tests

Details

In response to this:

/override OpenShift-Integration-tests/OpenShift-Integration-tests

I am overriding the test for now because the failure is unrelated to the changes made here, but the following failure needs to be investigated:

Expected
     <string>:   __
      /  \__     Developing using the "xpczcj" Devfile
      \__/  \    Namespace: cmd-logs-test189tbj
      /  \__/    odo version: v3.5.0
      \__/
     
     ↪ Deploying to the cluster in developer mode
      •  Waiting for Kubernetes resources  ...
      •  Creating resource Pod/myapp-inner  ...
     
✓  Creating resource Pod/myapp-inner 
      âš   Pod is Pending
      ✓  Pod is Running
      •  Deleting resources not present in the Devfile: PodMetrics/myapp-inner  ...
     
✓  Deleting resources not present in the Devfile: PodMetrics/myapp-inner [1s]
     Error occurred on Push - watch command was unable to push component: unable to delete remote resources: unable to delete resource: PodMetrics/myapp-inner: the server does not allow this method on the requested resource
     
      •  Deleting resources not present in the Devfile: PodMetrics/myapp-inner  ...
     
✓  Deleting resources not present in the Devfile: PodMetrics/myapp-inner [1s]
     Error occurred on Push - watch command was unable to push component: unable to delete remote resources: unable to delete resource: PodMetrics/myapp-inner: the server does not allow this method on the requested resource

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.

[valaparthvi]

/override ci/prow/v4.11-integration-e2e

[openshift-ci]

@valaparthvi: Overrode contexts on behalf of valaparthvi: ci/prow/v4.11-integration-e2e

Details

In response to this:

/override ci/prow/v4.11-integration-e2e

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.