From 5494f489442b80c3815d51a0d6a3f22ac1c449f8 Mon Sep 17 00:00:00 2001 From: Donovan Clay Date: Fri, 30 Aug 2024 11:30:31 -0700 Subject: [PATCH 1/2] **Description** Fix documentation to match functionality. **Testing Done** ran `sh./scripts/test.sh -h` to ensure the usage description is accurate. --- scripts/test.sh | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/scripts/test.sh b/scripts/test.sh index 04b9a3cd..1c6fcc81 100755 --- a/scripts/test.sh +++ b/scripts/test.sh @@ -2,13 +2,10 @@ usage() { printf """ -Usage: $(basename $0) --website='' [OPTIONS] - -Required: - --website='' URL of the Code Editor instance to test. +Usage: $(basename $0) [OPTIONS] Options: - -w ''| --website='' URL of the Code Editor instance to test. + -w ''|--website='' URL of the Code Editor instance to test (default: http://localhost:9888). -u|--unit-test Run OSS unit tests. -i|--integ-test Run OSS integration tests. -s|--style-check Run OSS style check. From faac3efd7b78ac5a4f4a270a5cfc923a19eb9057 Mon Sep 17 00:00:00 2001 From: Donovan Clay Date: Fri, 30 Aug 2024 12:22:34 -0700 Subject: [PATCH 2/2] Fix test.sh usage description in readme --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bbac49ca..a53e8f08 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,17 @@ Follow the previous steps to patch and build the project. Use the `./scripts/test.sh` script for testing. ``` -Usage: test.sh --website='' [OPTIONS] - -Required: - --website='' URL of the Code Editor instance to test. +Usage: test.sh [OPTIONS] Options: - -u|--unit-test Run OSS unit tests. - -i|--integ-test Run OSS integration tests. - -s|--style-check Run OSS style check. - -c|--cypress-integ-test Run Code Editor UI tests. - -l|--local Run Code Editor UI tests against a local instance (requires -c). - -n|--no-patches Skip automatic patching of OSS. - -h|--help Show this help message and exit. + -w ''|--website='' URL of the Code Editor instance to test (default: http://localhost:9888). + -u|--unit-test Run OSS unit tests. + -i|--integ-test Run OSS integration tests. + -s|--style-check Run OSS style check. + -c|--cypress-integ-test Run Code Editor UI tests. + -l|--local Run Code Editor UI tests against a local instance (requires -c). + -n|--no-patches Skip automatic patching of OSS. + -h|--help Show this help message and exit. ``` ***Note***: make sure you have the `'`quotes`'` around the website url.