feature: Fast-lane upgrade of CLI to latest version (#31)

* feature: Fast-lane upgrade of CLI to latest version
* Add integration test

Signed-off-by: Dennis Meister <[email protected]>

---------

Signed-off-by: Dennis Meister <[email protected]>
Co-authored-by: Dennis Meister <[email protected]>

Author: doosuu

.github/workflows/ci.yml

@@ -103,6 +103,9 @@ jobs:
           repository: eclipse-velocitas/vehicle-app-${{ matrix.language }}-template
           path: test/${{ matrix.language }}/repo
 
+      - name: Install requirements
+        run: pip install -r test/requirements.txt
+
       - name: Prepare .velocitas.json for integration test
         run: |
           COMMIT_REF=$GITHUB_SHA
@@ -138,6 +141,11 @@ jobs:
           cd test/${{ matrix.language }}/repo
           velocitas sync
 
+      - name: Test for CLI Auto-Upgrade
+        run: |
+          cd test/${{ matrix.language }}/repo
+          pytest -s ../../integration/test_poststart.py
+
       - name: Reset .velocitas.json to latest template state
         run: |
           cd test/${{ matrix.language }}/repo

setup/src/common/scripts/postStartCommand.sh

@@ -0,0 +1,80 @@
+#!/bin/bash
+# Copyright (c) 2023 Robert Bosch GmbH
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+echo "#######################################################"
+echo "### Auto-Upgrade CLI                                ###"
+echo "#######################################################"
+
+ROOT_DIRECTORY=$( realpath "$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )/../.." )
+DESIRED_VERSION=$(cat $ROOT_DIRECTORY/.velocitas.json | jq .cliVersion | tr -d '"')
+
+# Get installed CLI version
+INSTALLED_VERSION=v$(velocitas --version | sed -E 's/velocitas-cli\/(\w+.\w+.\w+).*/\1/')
+
+if [ "$DESIRED_VERSION" = "$INSTALLED_VERSION" ]; then
+  echo "> Already up to date!"
+  exit 0
+else
+  echo "> Checking upgrade to $DESIRED_VERSION"
+fi
+
+AUTHORIZATION_HEADER=""
+if [ "${GITHUB_API_TOKEN}" != "" ]; then
+  AUTHORIZATION_HEADER="-H \"Authorization: Bearer ${GITHUB_API_TOKEN}\""
+fi
+
+if [ "$DESIRED_VERSION" = "latest" ]; then
+  CLI_RELEASES_URL=https://api.github.com/repos/eclipse-velocitas/cli/releases/latest
+else
+  CLI_RELEASES_URL=https://api.github.com/repos/eclipse-velocitas/cli/releases/tags/${DESIRED_VERSION}
+fi
+
+CLI_RELEASES=$(curl -s -L \
+-H "Accept: application/vnd.github+json" \
+-H "X-GitHub-Api-Version: 2022-11-28" \
+${AUTHORIZATION_HEADER} \
+${CLI_RELEASES_URL})
+
+res=$?
+if test "$res" != "0"; then
+   echo "the curl command failed with exit code: $res"
+   exit 0
+fi
+
+DESIRED_VERSION_TAG=$(echo ${CLI_RELEASES} | jq -r .name)
+
+if [ "$DESIRED_VERSION_TAG" = "null" ] || [ "$DESIRED_VERSION_TAG" = "" ]; then
+  echo "> Can't find desired Velocitas CLI version: $DESIRED_VERSION. Skipping Auto-Upgrade."
+  exit 0
+fi
+
+if [ "$DESIRED_VERSION_TAG" != "$INSTALLED_VERSION" ]; then
+  echo "> Upgrading CLI..."
+  if [[ $(arch) == "aarch64" ]]; then
+    CLI_ASSET_NAME=velocitas-linux-arm64
+  else
+    CLI_ASSET_NAME=velocitas-linux-x64
+  fi
+  CLI_INSTALL_PATH=/usr/bin/velocitas
+  CLI_DOWNLOAD_URL="https://github.com/eclipse-velocitas/cli/releases/download/${DESIRED_VERSION_TAG}/${CLI_ASSET_NAME}"
+
+  echo "> Downloading Velocitas CLI from ${CLI_DOWNLOAD_URL}"
+  sudo curl -s -L ${CLI_DOWNLOAD_URL} -o "${CLI_INSTALL_PATH}"
+  sudo chmod +x "${CLI_INSTALL_PATH}"
+else
+  echo "> Up to date!"
+fi
+
+echo "> Using CLI: $(velocitas --version)"

setup/src/cpp/common/devcontainer.json

@@ -135,7 +135,8 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'onCreateCommand' to run commands when the container is created.
-	"onCreateCommand": "bash .devcontainer/scripts/postCreateCommand.sh",
+	"onCreateCommand": "bash .devcontainer/scripts/onCreateCommand.sh",
+	"postStartCommand": "bash .devcontainer/scripts/postStartCommand.sh",
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
 }

setup/src/cpp/common/scripts/postCreateCommand.sh renamed to setup/src/cpp/common/scripts/onCreateCommand.sh

@@ -89,7 +89,8 @@
 			]
 		}
 	},
-	"onCreateCommand": "bash .devcontainer/scripts/postCreateCommand.sh",
+	"onCreateCommand": "bash .devcontainer/scripts/onCreateCommand.sh",
+	"postStartCommand": "bash .devcontainer/scripts/postStartCommand.sh",
 	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
 }

setup/src/python/app/scripts/postCreateCommand.sh renamed to setup/src/python/app/scripts/onCreateCommand.sh

@@ -12,5 +12,6 @@
         "githubRepoId": "eclipse-velocitas/vehicle-app-cpp-template",
         "appExecutionPlatforms": "linux/amd64",
         "generatedModelPath": "./app/vehicle_model"
-    }
+    },
+    "cliVersion": "v0.5.5"
 }

setup/src/python/common/devcontainer.json

@@ -0,0 +1,86 @@
+# Copyright (c) 2023 Robert Bosch GmbH
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import json
+import os
+import platform
+from re import Pattern, compile, search
+from subprocess import PIPE, Popen, check_output
+
+older_cli_version = "v0.5.4"
+
+
+def get_cli_asset_name() -> str:
+    platform_arch = platform.machine()
+    cli_arch = "x64"
+    if platform_arch == "aarch64":
+        cli_arch = "arm64"
+    return f"velocitas-linux-{cli_arch}"
+
+
+def download_older_cli_version():
+    cli_asset_name = get_cli_asset_name()
+    cli_install_path = "/usr/bin/velocitas"
+    cli_download_url = (
+        "https://github.com/eclipse-velocitas/cli/"
+        f"releases/download/{older_cli_version}/{cli_asset_name}"
+    )
+
+    print(
+        f"Downloading CLI version {older_cli_version}"
+        "from {cli_download_url} to {cli_install_path}"
+    )
+    download_cli = f"sudo curl -s -L {cli_download_url} -o {cli_install_path}"
+    chmod = f"sudo chmod +x {cli_install_path}"
+
+    cli_download_process = Popen(download_cli, stdout=PIPE, shell=True)
+    cli_download_process.wait()
+    Popen(chmod, stdout=PIPE, shell=True)
+
+
+def get_cli_version():
+    velocitas_version_output = check_output(["velocitas", "--version"]).decode()
+    search_velocitas_version_regex: Pattern[str] = compile(
+        r"velocitas-cli\/(\w+.\w+.\w+).*"
+    )
+    cli_version = search(
+        search_velocitas_version_regex, velocitas_version_output
+    ).group(1)
+    return f"v{cli_version}"
+
+
+def test_post_start_auto_upgrade_cli():
+    download_older_cli_version()
+    # This should be the right check
+    # But since we do not have a proper version output
+    # on previous CLI releases we need to have a workaround
+    # assert get_cli_version() == older_cli_version
+    assert get_cli_version() == "v0.0.0"
+
+    post_create_script_path = os.path.join(
+        os.getcwd(),
+        ".devcontainer",
+        "scripts",
+        "postStartCommand.sh",
+    )
+
+    post_create_script_process = Popen(
+        f"{post_create_script_path}", stdout=PIPE, shell=True
+    )
+
+    post_create_script_process.wait()
+
+    velocitas_json = open(os.path.join(os.getcwd(), ".velocitas.json"))
+    data = json.load(velocitas_json)
+    assert data["cliVersion"] == get_cli_version()

setup/src/python/sdk/scripts/postCreateCommand.sh renamed to setup/src/python/sdk/scripts/onCreateCommand.sh

@@ -11,5 +11,6 @@
         "appManifestPath": "app/AppManifest.json",
         "githubRepoId": "eclipse-velocitas/vehicle-app-python-template",
         "generatedModelPath": "./gen/vehicle_model"
-    }
+    },
+    "cliVersion": "v0.5.5"
 }