fix: Fix some bugs in shell scripts (#29)

1. Fix the incorrect format of file:// URLs supported in configuration
2. Always create a default McpBridge resource for editing
3. Exclude the test folder when decompressing during installation

Author: CH3CHO

README.md

@@ -47,7 +47,7 @@ docker compose
 
     配置服务的 URL。
     - 若使用独立部署的 Nacos 服务，URL 格式为：nacos://192.168.0.1:8848
-    - 若在本地磁盘上保存配置，URL 格式为：file://opt/higress/conf
+    - 若在本地磁盘上保存配置，URL 格式为：file:///opt/higress/conf
 
   * --use-builtin-nacos
 
@@ -71,7 +71,7 @@ docker compose
 
   * -p, --console-password=CONSOLE-PASSWORD
 
-    后续用户访问 Higress Console 的密码（用户名固定为 `admin`）。默认值为 `admin`。
+    后续用户访问 Higress Console 的密码（用户名固定为 `admin`）。若未设置，Higress 将自动生成一个随机的密码。
 
   * --nacos-port=NACOS-PORT
 
@@ -81,7 +81,7 @@ docker compose
 
     Higress Gateway 在服务器本地监听的 HTTP 端口。默认值为 80。
 
-  * --gateway-https-port=GATEAWY-HTTPS-PORT
+  * --gateway-https-port=GATEWAY-HTTPS-PORT
 
     Higress Gateway 在服务器本地监听的 HTTPS 端口。默认值为 443。
 

bin/configure.sh

@@ -192,6 +192,7 @@ configure() {
 }
 
 resetEnv() {
+  COMPOSE_PROFILES=""
   CONFIG_STORAGE=""
   FILE_ROOT_DIR=""
   NACOS_SERVER_URL=""
@@ -276,12 +277,23 @@ configureFileStorageByArgs() {
 
   FILE_ROOT_DIR="${CONFIG_URL#file://}"
   if [ "$OS" == "windows" ]; then
-    if [[ "$FILE_ROOT_DIR" == *":"* ]]; then
-      FILE_ROOT_DIR="${FILE_ROOT_DIR//\\//}"
-    else 
-      FILE_ROOT_DIR="/${FILE_ROOT_DIR//\\//}"
+    # Fix path separators
+    FILE_ROOT_DIR="${FILE_ROOT_DIR//\\//}"
+    if [[ "$FILE_ROOT_DIR" == "."* ]] || [[ "$FILE_ROOT_DIR" == "~/"* ]]; then
+      # A relatpath ive or user home based path. Do nothing.
+      :
+    elif [[ "$FILE_ROOT_DIR" != "/"* ]]; then
+      echo 'Invalid file URL. Relative path must begin with a ".". Absolute path must begin with a "/" or "~/".'
+      exit -1
+    elif [[ "$FILE_ROOT_DIR" == *":"* ]]; then
+      FILE_ROOT_DIR="${FILE_ROOT_DIR#/}"
     fi
   fi
+  if [[ "$FILE_ROOT_DIR" == '~/'* ]]; then
+    # A user home based path.
+    FILE_ROOT_DIR="${HOME}${FILE_ROOT_DIR#\~}"
+  fi
+  echo "Root: $FILE_ROOT_DIR"
   mkdir -p "$FILE_ROOT_DIR" && cd "$_"
   if [ $? -ne 0 ]; then
     echo "Unable to create/access the config folder. Please fix it or choose another one."
@@ -415,7 +427,9 @@ configureFileStorage() {
     readNonEmpty "Please input the root path of config folder: "
     FILE_ROOT_DIR="$input"
     if [ "$OS" == "windows" ]; then
-      if [[ "$FILE_ROOT_DIR" == "/"* ]]; then
+      if [[ "$FILE_ROOT_DIR" == "."* ]]; then
+        :
+      elif [[ "$FILE_ROOT_DIR" == "/"* ]]; then
         :
       elif [[ "$FILE_ROOT_DIR" == *":"* ]]; then
         FILE_ROOT_DIR="${FILE_ROOT_DIR//\\//}"
@@ -474,7 +488,7 @@ outputUsage() {
  -a, --auto-start           start Higress after configuration
  -c, --config-url=URL       URL of the config storage
                             Use Nacos with format: nacos://192.168.0.1:8848
-                            Use local files with format: file://opt/higress/conf
+                            Use local files with format: file:///opt/higress/conf
      --use-builtin-nacos    use the built-in Nacos service instead of
                             an external one to store configurations
      --nacos-ns=NACOS-NAMESPACE

compose/scripts/init.sh

@@ -89,7 +89,7 @@ publishFileConfig() {
 
   if [ "$skipWhenExisted" == true ] && [ -f "$configFile" ]; then
       echo "  Config file [$configFile] already exists"
-      exit 0
+      return 0
   fi
 
   mkdir -p "$configDir"
@@ -381,6 +381,17 @@ initializeGateway() {
 initializeMcpBridge() {
   echo "Initializing McpBridge resource..."
 
+  read -r -d '' content << EOF
+apiVersion: networking.higress.io/v1
+kind: McpBridge
+metadata:
+  creationTimestamp: "$(now)"
+  name: default
+  namespace: higress-system
+spec:
+  registries:
+EOF
+
   if [ "$CONFIG_STORAGE" == "nacos" ]; then
     if [[ "$NACOS_SERVER_URL" =~ ^http://([a-zA-Z0-9.]+?)(:([0-9]+))/nacos$ ]]; then
       NACOS_SERVER_DOMAIN="${BASH_REMATCH[1]}"
@@ -410,14 +421,7 @@ EOF
     fi
 
     read -r -d '' content << EOF
-apiVersion: networking.higress.io/v1
-kind: McpBridge
-metadata:
-  creationTimestamp: "$(now)"
-  name: default
-  namespace: higress-system
-spec:
-  registries:
+${content}
   - domain: ${NACOS_SERVER_DOMAIN}
     nacosGroups:
     - DEFAULT_GROUP
@@ -427,8 +431,9 @@ spec:
     type: nacos2
     authSecretName: "${nacosAuthSecretName}"
 EOF
-    publishConfig "higress-system" "mcpbridges" "default" "$content"
   fi
+
+  publishConfig "higress-system" "mcpbridges" "default" "$content"
 }
 
 initializeConsole() {

src/get-higress.sh

@@ -71,7 +71,7 @@ outputUsage() {
   echo '
  -c, --config-url=URL       URL of the config storage
                             Use Nacos with format: nacos://192.168.0.1:8848
-                            Use local files with format: file://opt/higress/conf
+                            Use local files with format: file:///opt/higress/conf
      --use-builtin-nacos    use the built-in Nacos service instead of
                             an external one
      --nacos-ns=NACOS-NAMESPACE
@@ -190,7 +190,7 @@ download() {
 
 # install installs the product.
 install() {
-  tar -zx --exclude="docs" --exclude="src" -f "$HIGRESS_TMP_FILE" -C "$DESTINATION" --strip-components=1
+  tar -zx --exclude="docs" --exclude="src" --exclude="test" -f "$HIGRESS_TMP_FILE" -C "$DESTINATION" --strip-components=1
   bash "$DESTINATION/bin/configure.sh" --auto-start ${CONFIG_ARGS[@]}
 }
 

test/configure/cases/args-file-full_non-windows.inc

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-CONFIGURE_ARGS="-c file://tmp/higress/data --console-password=helloworld --gateway-http-port=30002 --gateway-https-port=30003 --gateway-metrics-port=30004 --console-port=30005"
+CONFIGURE_ARGS="-c file:///tmp/higress/data --console-password=helloworld --gateway-http-port=30002 --gateway-https-port=30003 --gateway-metrics-port=30004 --console-port=30005"
 
 CONFIGURE_INPUT=""
 

test/configure/cases/args-file-full_windows.inc

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-CONFIGURE_ARGS="-c file://c/temp/higress/data --console-password=helloworld --gateway-http-port=30002 --gateway-https-port=30003 --gateway-metrics-port=30004 --console-port=30005"
+CONFIGURE_ARGS="-c file:///c/temp/higress/data --console-password=helloworld --gateway-http-port=30002 --gateway-https-port=30003 --gateway-metrics-port=30004 --console-port=30005"
 
 CONFIGURE_INPUT=""
 

test/configure/cases/args-file-path-relative_non-windows.inc

@@ -0,0 +1,27 @@
+#  Copyright (c) 2023 Alibaba Group Holding Ltd.
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#       http:www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+CONFIGURE_ARGS="-c file://./higress/data"
+
+CONFIGURE_INPUT=""
+
+declare -A EXPECTED_ENVS=(
+  ["COMPOSE_PROFILES"]=''
+  ["CONFIG_STORAGE"]='file'
+  ["FILE_ROOT_DIR"]="$(pwd)/higress/data"
+  ["GATEWAY_HTTP_PORT"]='80'
+  ["GATEWAY_HTTPS_PORT"]='443'
+  ["GATEWAY_METRICS_PORT"]='15020'
+  ["CONSOLE_PORT"]='8080'
+)

test/configure/cases/args-file-path-relative_windows.inc

@@ -0,0 +1,27 @@
+#  Copyright (c) 2023 Alibaba Group Holding Ltd.
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#       http:www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+CONFIGURE_ARGS="-c file://./higress/data"
+
+CONFIGURE_INPUT=""
+
+declare -A EXPECTED_ENVS=(
+  ["COMPOSE_PROFILES"]=''
+  ["CONFIG_STORAGE"]='file'
+  ["FILE_ROOT_DIR"]="$(cygpath -w "$PWD")\\higress\\data"
+  ["GATEWAY_HTTP_PORT"]='80'
+  ["GATEWAY_HTTPS_PORT"]='443'
+  ["GATEWAY_METRICS_PORT"]='15020'
+  ["CONSOLE_PORT"]='8080'
+)

test/configure/cases/args-file-path-with-colon_windows.inc

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-CONFIGURE_ARGS="-c file://c/temp/higress/data"
+CONFIGURE_ARGS="-c file:///c:/temp/higress/data"
 
 CONFIGURE_INPUT=""
 

test/configure/cases/input-file-full_non-windows.inc

@@ -17,7 +17,6 @@ CONFIGURE_ARGS=""
 CONFIGURE_INPUT="file
 /tmp/higress/data
 admin
-30001
 30002
 30003
 30004