Adding documentation for tests #819
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
size/M
|
we have to do |
cdrage
reviewed
Sep 26, 2017
script/test_in_openshift/README.md
Outdated
|
|
||
| ## Introduction | ||
|
|
||
| The functional tests for Kompose on OpenShift cluster leverages oc cluster up` to bring a single-cluster OpenShift instance. The test scripts |
There was a problem hiding this comment.
you forgot to add and extra `
it's suppose to be oc cluster up
cdrage
requested changes
Sep 26, 2017
script/test_in_openshift/README.md
Outdated
| The functional tests for Kompose on OpenShift cluster leverages oc cluster up` to bring a single-cluster OpenShift instance. The test scripts | ||
| are hosted under script/test_in_openshift. The directory structure is as below: | ||
|
|
||
| script/test_in_openshift/ |
script/test_in_openshift/README.md
Outdated
| - [compose-files/](/script/test_in_openshift/compose-files/) directory contains the docker compose | ||
| file used by the test scripts | ||
|
|
||
| - The scripts use [`oc cluster up`](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) for setting up a single-machine OpenShift cluster. It exits if oc binaries are not installed |
script/test_in_openshift/README.md
Outdated
|
|
||
| - The scripts use [`oc cluster up`](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) for setting up a single-machine OpenShift cluster. It exits if oc binaries are not installed | ||
|
|
||
| - Most of the docker compose files used are the ones already available under [examples/](/examples] or [/script/test/fixtures](/script/test/fixtures). |
There was a problem hiding this comment.
don't add 'most of the docker compose files'
just say Docker Compose examples are available under examples/
script/test_in_openshift/README.md
Outdated
|
|
||
| ## Running OpenShift tests | ||
|
|
||
| ### Install `oc cluster up` |
There was a problem hiding this comment.
random spacing between oc and cluster
ashetty1
force-pushed
the
issue_781
branch
2 times, most recently
from
078fa87 to
dc3f49c
Compare
cdrage
requested changes
Oct 6, 2017
script/test_in_openshift/README.md
Outdated
|
|
||
| ## Running OpenShift tests | ||
|
|
||
| ### Install `oc cluster up` |
There was a problem hiding this comment.
Random spacing?
Install what though?
I think you mean Deploy oc cluster up
script/test_in_openshift/README.md
Outdated
|
|
||
| ### Install `oc cluster up` | ||
|
|
||
| The scripts use [`oc cluster up`](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) for setting up a single-machine OpenShift cluster. Installing oc binary is a pre-requisite for running these tests |
There was a problem hiding this comment.
missing period at end of sentence.
script/test_in_openshift/README.md
Outdated
| - [compose-files/](/script/test_in_openshift/compose-files/) directory contains the docker compose | ||
| file used by the test scripts | ||
|
|
||
| - The scripts use [`oc cluster up`](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) for setting up a single-machine OpenShift cluster. It exits if oc binaries are not installed |
There was a problem hiding this comment.
missing period at end of sentence.
script/test_in_openshift/README.md
Outdated
|
|
||
| - [tests/](/script/test_in_openshift/tests) directory contains the test scripts | ||
|
|
||
| - [compose-files/](/script/test_in_openshift/compose-files/) directory contains the docker compose |
There was a problem hiding this comment.
missing period at end of sentence.
script/test_in_openshift/README.md
Outdated
| - [run.sh](/script/test_in_openshift/run.sh) is the master script | ||
| which executes all the tests | ||
|
|
||
| - [lib.sh](/script/test_in_openshift/lib.sh) consists of helper functions |
There was a problem hiding this comment.
missing period at end of sentence.
script/test_in_openshift/README.md
Outdated
| └── .. | ||
| ``` | ||
|
|
||
| - [run.sh](/script/test_in_openshift/run.sh) is the master script |
There was a problem hiding this comment.
missing period at end of sentence.
There was a problem hiding this comment.
fix this @ashetty1 then all good from here 👍 feel free to merge after you've added the period.
script/test_in_openshift/README.md
Outdated
| ## Introduction | ||
|
|
||
| The functional tests for Kompose on OpenShift cluster leverages `oc cluster up` to bring a single-cluster OpenShift instance. The test scripts | ||
| are hosted under script/test_in_openshift. The directory structure is as below: |
There was a problem hiding this comment.
remove random newline. Or do newline after the script/test_in_openshift sentence.
script/test_in_openshift/README.md
Outdated
|
|
||
| The scripts use [`oc cluster up`](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) for setting up a single-machine OpenShift cluster. Installing oc binary is a pre-requisite for running these tests | ||
|
|
||
| Run `make test-openshift` to run the OpenShift tests |
There was a problem hiding this comment.
Use make test-openshift to run the OpenShift tests.
cdrage
approved these changes
Oct 26, 2017
|
LGTM! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of issue #781