Merge pull request #62 from aws/fix-test-script-description

Fix test.sh usage description
aws · Sep 3, 2024 · fbac79c · fbac79c
2 parents 20dd002 + faac3ef
commit fbac79c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 16 deletions.
diff --git 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='<WEBSITE-URL>' [OPTIONS]
-
-Required:
-    --website='<WEBSITE-URL>'     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>'|--website='<WEBSITE_URL>'        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.
 

diff --git a/scripts/test.sh b/scripts/test.sh
@@ -2,13 +2,10 @@
 
 usage() {
     printf """
-Usage: $(basename $0) --website='<WEBSITE-URL>' [OPTIONS]
-
-Required:
-    --website='<WEBSITE-URL>'     URL of the Code Editor instance to test.
+Usage: $(basename $0) [OPTIONS]
 
 Options:
-    -w '<WEBSITE-URL>'| --website='<WEBSITE_URL>'       URL of the Code Editor instance to test.
+    -w '<WEBSITE-URL>'|--website='<WEBSITE_URL>'        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.