ENG-4443 Part 1. Create update scripts to update an app and the manifest

.gitignore

@@ -158,3 +158,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Go stuff
+go.work
+go.work.sum

.golangci.yml

@@ -1,7 +1,7 @@
 # Options for analysis running. Details: https://golangci-lint.run/usage/configuration/#run-configuration
 run:
   timeout: 5m
-  go: "1.19"
+  go: "1.21"
 
 # Configures linters. Details: https://golangci-lint.run/usage/linters
 linters-settings:
@@ -12,39 +12,16 @@ linters-settings:
   gomodguard:
     allowed:
       modules:
-        - github.com/nextmv-io/sdk
-        - github.com/nextmv-io/sdk/route
-        - github.com/nextmv-io/sdk/route/osrm
-        - github.com/nextmv-io/sdk/route/here
-        - github.com/nextmv-io/sdk/route/google
-        - github.com/nextmv-io/sdk/route/routingkit
-        - github.com/nextmv-io/sdk/measure/here
-        - github.com/nextmv-io/sdk/measure/osrm
-        - github.com/nextmv-io/sdk/measure/google
-        - github.com/nextmv-io/sdk/measure/routingkit
-        - googlemaps.github.io/maps
-        - github.com/dgraph-io/ristretto
-        - go.uber.org/mock
-        - github.com/google/go-cmp
-        - github.com/hashicorp/golang-lru
-        - github.com/nextmv-io/go-routingkit
-        - github.com/twpayne/go-polyline
-        - googlemaps.github.io/maps
-        - github.com/itzg/go-flagsfiller
-        - github.com/gorilla/schema
-        - github.com/google/uuid
-        - github.com/xeipuuv/gojsonschema
-        - github.com/danielgtaylor/huma
   # Allow increased cyclomatic complexity for examples.
   gocyclo:
     min-complexity: 45
   # Set correct go version.
   gosimple:
-    go: "1.19"
+    go: "1.21"
   staticcheck:
-    go: "1.19"
+    go: "1.21"
   stylecheck:
-    go: "1.19"
+    go: "1.21"
   # Check case of struct tags
   tagliatelle:
     case:

VERSION

@@ -0,0 +1 @@
+v0.1.0

knapsack-gosdk/VERSION

@@ -0,0 +1 @@
+v1.2.0

knapsack-java-ortools/VERSION

@@ -0,0 +1 @@
+v1.2.0

knapsack-ortools/VERSION

@@ -0,0 +1 @@
+v1.2.0

knapsack-pyomo/VERSION

@@ -0,0 +1 @@
+v1.2.0

nextroute/VERSION

@@ -0,0 +1 @@
+v1.2.0

order-fulfillment-gosdk/VERSION

@@ -0,0 +1 @@
+v1.2.0

requirements.txt

@@ -0,0 +1,2 @@
+pyyaml==6.0.1
+ruff==0.1.7

routing-ortools/VERSION

@@ -0,0 +1 @@
+v1.2.0

scripts/update_app.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+set -e
+
+# ================= README =================
+# Updates an app to the desired version.
+
+# Required exports.
+# APP: the name of the app to update.
+# VERSION: the version to update to.
+
+# ================= Checks =================
+# Checks that APP is set.
+echo "🐰 Checking the value of APP"
+if [[ -z "${APP}" ]]; then
+    echo "❌ APP must be set"
+    exit -1
+fi
+
+# Checks that VERSION is set.
+echo "🐰 Checking the value of VERSION"
+if [[ -z "${VERSION}" ]]; then
+    echo "❌ VERSION must be set"
+    exit -1
+fi
+
+# ================= App info =================
+# Get the info of the app from the configuration file.
+WORFKLOW_CONFIGURATION="workflow-configuration.yml"
+INFO=$(yq '.apps[] | select(.name == strenv(APP))' workflow-configuration.yml)
+echo "🐰 App info:"
+echo "$INFO" | yq .
+
+# ================= Directory =================
+# Change to the APP directory.
+cd "$(dirname "$0")/.."
+echo "🐰 Current dir is: $(pwd)"
+echo "🐰 Changing to dir $APP"
+cd $APP
+
+# ================= Update =================
+# Update the VERSION file to the VERSION.
+OLD=$(cat VERSION)
+echo "🐰 Updating the VERSION file from $OLD to $VERSION"
+echo $VERSION > VERSION
+
+# If the app is a Go app, update the go.mod file.
+TYPE=$(echo "$INFO" | yq .type)
+echo "🐰 App type is $TYPE"
+if [[ $TYPE == "go" ]]; then
+    SDK_VERSION=$(echo "$INFO" | yq .sdk_version)
+    echo "🐰 SDK version is $SDK_VERSION"
+    echo "🐰 Updating the go.mod file"
+    go get github.com/nextmv-io/sdk@$SDK_VERSION
+    go mod tidy
+fi

scripts/update_manifest.py

@@ -0,0 +1,104 @@
+"""
+This script updates the manifest file with the latest version of the release
+and the apps. It assumes that there is a `manifest.yml` file which corresponds
+to the old manifest. It writes the new manifest to `new_manifest.yml`. Versions
+are taken from the `VERSION` file in each app directory, and the root.
+
+Execute from the root:
+
+```bash
+python scripts/update_manifest.py
+```
+"""
+import copy
+import os
+from typing import Any
+
+import yaml
+
+
+def main():
+    """
+    Entry point for the script.
+    """
+
+    apps = [
+        {
+            "name": app["name"],
+            "type": app["type"],
+            "version": version(dir=app["name"]),
+        }
+        for app in open_yaml_file(filepath="workflow-configuration.yml")["apps"]
+    ]
+    apps.sort(key=lambda x: x["name"])
+    old = open_yaml_file(filepath="manifest.yml")
+    new = update_manifest(old=old, apps=apps)
+    with open("new_manifest.yml", "w") as f:
+        yaml.dump(new, f)
+
+
+def update_manifest(
+    old: dict[str, Any],
+    apps: list[dict[str, str]],
+) -> dict[str, Any]:
+    """
+    Updates the manifest with the new apps.
+
+    Args:
+        old: The old manifest.
+        apps: The list of apps.
+
+    Returns:
+        The new manifest.
+    """
+
+    new = copy.deepcopy(old)
+    new_version = version(dir=".")
+    new["latest"] = new_version
+    release = {
+        "version": new_version,
+        "apps": apps,
+    }
+    new["releases"].append(release)
+
+    return new
+
+
+def open_yaml_file(filepath: str) -> dict[str, Any]:
+    """
+    Returns the YAML file in the path.
+
+    Args:
+        filepath: The path of the file.
+
+    Returns:
+        The content of the YAML file.
+
+    Raises:
+        FileNotFoundError: If the file is not found.
+    """
+
+    with open(filepath) as f:
+        return yaml.safe_load(f)
+
+
+def version(dir: str) -> str:
+    """
+    Returns the version in the given directory.
+
+    Args:
+        dir: The directory.
+
+    Returns:
+        The version.
+
+    Raises:
+        FileNotFoundError: If the VERSION file is not found.
+    """
+
+    with open(os.path.join(dir, "VERSION")) as f:
+        return f.read().strip()
+
+
+if __name__ == "__main__":
+    main()

shift-assignment-ortools/VERSION

@@ -0,0 +1 @@
+v1.2.0

shift-assignment-pyomo/VERSION

@@ -0,0 +1 @@
+v1.2.0

shift-planning-ortools/VERSION

@@ -0,0 +1 @@
+v1.2.0

shift-planning-pyomo/VERSION

@@ -0,0 +1 @@
+v1.2.0

shift-scheduling-gosdk/VERSION

@@ -0,0 +1 @@
+v1.2.0

workflow-configuration.yml

@@ -0,0 +1,31 @@
+apps:
+  - name: knapsack-gosdk
+    type: go
+    sdk_version: latest
+  - name: knapsack-java-ortools
+    type: java
+  - name: knapsack-ortools
+    type: python
+  - name: knapsack-pyomo
+    type: python
+  - name: nextroute
+    type: go
+    sdk_version: latest
+  - name: order-fulfillment-gosdk
+    type: go
+    sdk_version: latest
+  - name: routing-ortools
+    type: python
+  - name: shift-assignment-ortools
+    type: python
+  - name: shift-assignment-pyomo
+    type: python
+  - name: shift-planning-ortools
+    type: python
+  - name: shift-planning-pyomo
+    type: python
+  - name: shift-scheduling-gosdk
+    type: go
+    sdk_version: latest
+  - name: xpress
+    type: python

xpress/VERSION

@@ -0,0 +1 @@
+v1.2.0