Merge branch 'main' into 271-opensearch-containers

mfarina1 · web-flow · commit 915aa0813ed0 · 2026-07-07T10:16:30.000-04:00
diff --git a/.githooks/install.sh b/.githooks/install.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+ln -s ${PWD}/.githooks/update-env-hook.sh ${PWD}/.git/hooks/post-commit
+ln -s ${PWD}/.githooks/update-env-hook.sh ${PWD}/.git/hooks/post-checkout
+ln -s ${PWD}/.githooks/update-env-hook.sh ${PWD}/.git/hooks/post-merge
+ln -s ${PWD}/.githooks/update-env-hook.sh ${PWD}/.git/hooks/post-rewrite
diff --git a/.githooks/update-env-hook.sh b/.githooks/update-env-hook.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+repo_root=$(git rev-parse --show-toplevel)
+exec "$repo_root/update_env.sh"
diff --git a/.github/workflows/anms-core.yaml b/.github/workflows/anms-core.yaml
@@ -14,6 +14,8 @@ jobs:
         uses: actions/checkout@v6
         with:
           submodules: recursive
+      - name: Set ENV
+        run: ./update_env.sh
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
@@ -42,6 +44,8 @@ jobs:
         uses: actions/checkout@v6
         with:
           submodules: recursive
+      - name: Set ENV
+        run: ./update_env.sh
       - name: Build ANMS
         run: ${DOCKER_CMD} compose ${ANMS_COMPOSE_OPTS} build
       - name: Build TEST
diff --git a/.github/workflows/aricodec.yaml b/.github/workflows/aricodec.yaml
@@ -14,6 +14,8 @@ jobs:
         uses: actions/checkout@v6
         with:
           submodules: recursive
+      - name: Set ENV
+        run: ./update_env.sh
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
diff --git a/.github/workflows/build-test.yaml b/.github/workflows/build-test.yaml
@@ -42,6 +42,8 @@ jobs:
         run: |
           DOCKER_IMAGE_TAG=${{ github.sha }}
           echo "DOCKER_IMAGE_TAG=${DOCKER_IMAGE_TAG}" >> $GITHUB_ENV
+      - name: Set ENV file
+        run: ./update_env.sh
       - name: Build ANMS
         run: ${DOCKER_CMD} compose ${ANMS_COMPOSE_OPTS} build
       - name: Build Agents
diff --git a/.github/workflows/publish_images.yaml b/.github/workflows/publish_images.yaml
@@ -43,7 +43,8 @@ jobs:
           else
             echo "DOCKER_IMAGE_TAG=latest" >> $GITHUB_ENV
           fi
-
+      - name: Set ENV
+        run: ./update_env.sh
       - name: Build and push base images via compose
         run: |
           docker compose build --push
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-
+.env
 *~
 .idea/
 *~
diff --git a/README.md b/README.md
@@ -121,6 +121,8 @@ To start the system in the future, use `podman compose -f testenv-compose.yml up
 ## Manual Startup
 Choose the appropriate docker, podman, or podman-compose commands in the directions below as appropriate for your system.
 
+- Run `./update_env.sh` to copy `example.env` to `.env` and populate BUILD_VERSION env variables.
+  - It is also recommended to run `./githooks/install.sh` to install git hooks to automatically run this on any git commit/checkout/pull operation when updating in the future.
 - Edit `.env` file as appropriate.
   - Select appropriate profile(s) as desired. 
     - Core ANMS services are always started.
diff --git a/anms-core/anms/routes/adms/adm.py b/anms-core/anms/routes/adms/adm.py
@@ -135,7 +135,7 @@ async def load_default_adm():
     return response
 
 @router.post("/", status_code=status.HTTP_201_CREATED,
-             responses={400: {"model": RequestError}, 405: {"model": UpdateAdmError}, 500: {"model": RequestError}})
+             responses={200: {}, 400: {"model": RequestError}, 405: {"model": UpdateAdmError}, 500: {"model": RequestError}})
 async def update_adm(file: UploadFile, request: Request):
     response = None
     status_code = status.HTTP_201_CREATED
diff --git a/anms-core/anms/routes/mappings.py b/anms-core/anms/routes/mappings.py
@@ -34,7 +34,7 @@ class RoutesMapper(str, Enum):
     base_prefix = posixpath.join("/", config['SERVER_CHROOT']).rstrip("/") + "/"
 
     # Route Paths
-    hello_api_prefix = posixpath.join(base_prefix, "hello") + "/"
+    version_api_prefix = posixpath.join(base_prefix, "version") + "/"
     agents_api_prefix = posixpath.join(base_prefix, "agents") + "/"
     parameter_api_prefix = posixpath.join(base_prefix, "agents", "parameter") +"/"
 
diff --git a/anms-core/anms/routes/registry.py b/anms-core/anms/routes/registry.py
@@ -25,7 +25,7 @@
 
 from fastapi import APIRouter
 
-from anms.routes import hello, main, network_manager, logging, transcoder, system_status, user, agent_parameter
+from anms.routes import version, main, network_manager, logging, transcoder, system_status, user, agent_parameter
 from anms.routes.ARIs import agents, actual_objects, formal_parameter, formal_objects, \
     ari, actual_parameter, reports, alerts
 from anms.routes.adms import adm
@@ -43,7 +43,7 @@ def init_routing_table(self) -> None:
         # Router Path Order Matters https://fastapi.tiangolo.com/tutorial/path-params/#order-matters
 
         # Other API Mounts
-        self.routing_table[RoutesMapper.hello_api_prefix] = hello.router
+        self.routing_table[RoutesMapper.version_api_prefix] = version.router
         self.routing_table[RoutesMapper.agents_api_prefix] = agents.router
         self.routing_table[RoutesMapper.parameter_api_prefix] = agent_parameter.router
 
diff --git a/anms-core/anms/routes/version.py b/anms-core/anms/routes/version.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2023 The Johns Hopkins University Applied Physics
+# Copyright (c) 2026 The Johns Hopkins University Applied Physics
 # Laboratory LLC.
 #
 # This file is part of the Asynchronous Network Management System (ANMS).
@@ -21,16 +21,31 @@
 # the prime contract 80NM0018D0004 between the Caltech and NASA under
 # subcontract 1658085.
 #
-
+import os
 from fastapi import APIRouter
 from fastapi import status
 from fastapi.responses import PlainTextResponse
+from pydantic import BaseModel
+
+router = APIRouter(tags=["VERSION"])
+
+class VersionInfo(BaseModel):
+    # Build time version information
+    build_version: str
+    build_date: str
+    # Git version information (runtime, if available. If this doesn't match above, user may not have rebuilt)
+    git_version: str
+    git_date: str
+
 
-router = APIRouter(tags=["Examples"])
 
+# GET 	/version 	Return version information
+@router.get("/", response_model=VersionInfo, status_code=status.HTTP_200_OK)
+async def anms_get_version():
+    return VersionInfo(
+        build_version=os.getenv("BUILD_VERSION", "unknown"),
+        build_date=os.getenv("BUILD_DATE", "unknown"),
 
-@router.get("", status_code=status.HTTP_200_OK)
-async def hello_world():
-    return PlainTextResponse(
-        content="Hello World", status_code=status.HTTP_200_OK
+        git_version=os.getenv("GIT_VERSION", "unknown"),
+        git_date=os.getenv("GIT_DATE", "unknown"),
     )
diff --git a/anms-ui/modify_version.sh b/anms-ui/modify_version.sh
@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+set -e
 ##
 ## Copyright (c) 2023 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
@@ -19,13 +21,23 @@
 ## the prime contract 80NM0018D0004 between the Caltech and NASA under
 ## subcontract 1658085.
 ##
-ORIGFILE="../anms-ui/public/app/shared/TEMPLATE_constants.js"
-OUTFILE="../anms-ui/public/app/shared/constants.js"
-TMPFILE=$(mktemp)
-UI_VERSION="$(git describe --tags)"
-sed "s/UI_VERSION/$UI_VERSION/" "${ORIGFILE}" > $OUTFILE
-if diff -q "${TMPFILE}" "${OUTFILE}" >/dev/null; then
-    mv "${TMPFILE}" "${OUTFILE}"
-else
-    rm "${TMPFILE}"
-fi
+
+# --------------------------------------------------------------------
+# Determine the UI version.
+#   - If BUILD_VERSION is defined in the environment, use it.
+#   - Otherwise, fall back to the result of `git describe --tags`.
+# --------------------------------------------------------------------
+UI_VERSION="${BUILD_VERSION:-$(git describe --tags)}"
+
+# Path to the file that contains the placeholder version.
+TARGET_FILE="./src/environments/environment.ts"
+
+# --------------------------------------------------------------------
+# In‑place replacement:
+#   The line in environment.ts looks like:
+#       UI_VERSION: 'unknown', // NOTE: Auto‑updated at build‑time …
+#   We replace whatever is between the single quotes with $UI_VERSION.
+# --------------------------------------------------------------------
+sed -i.bak -E "s/(UI_VERSION:[[:space:]]*')[^']*(')/\1${UI_VERSION}\2/" "$TARGET_FILE"
+
+echo "UI_VERSION updated to '${UI_VERSION}' in ${TARGET_FILE}"
diff --git a/anms-ui/src/app/layout/header/header.html b/anms-ui/src/app/layout/header/header.html
@@ -1,7 +1,7 @@
 <div>
   <mat-toolbar>
     <span class="cursor-pointer" routerLink="home" matTooltip="Dashboard home">AMMOS ANMS</span>
-    <span class="ps-2">Version - v{{ uiVersion }}</span>
+    <span class="ps-2">Version - {{ uiVersion }}</span>
     <span class="spacer"></span>
     <button matIconButton matTooltip="User settings">
       <mat-icon>admin_panel_settings</mat-icon>
diff --git a/anms-ui/src/environments/environment.ts b/anms-ui/src/environments/environment.ts
@@ -1,5 +1,5 @@
 export const environment = {
-  UI_VERSION: '2.0.0-11-g80a27c5', // FIXME: hardcoded for now, where should this be populated from? and should version bump?
+  UI_VERSION: 'unknown', // NOTE: Auto-updated at build-time by modify_version.sh
   VUE_APP_STATUS_REFRESH_RATE: 60000, // milliseconds
 
   BASE_API_URL: 'http://anms-test:8080',
diff --git a/anms.Containerfile b/anms.Containerfile
@@ -35,8 +35,8 @@ RUN if [ -n "$INTERNAL_CERT_URL" ]; then \
     else \
         echo "⚙️  INTERNAL_CERT_URL not set – skipping internal CA import"; \
     fi
-
 # ---------------------------------------------------------------------------
+
 ENV PIP_CERT=/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem
 ENV PIP_DEFAULT_TIMEOUT=300
 
@@ -111,30 +111,38 @@ FROM yarn-base AS anms-ui
 ENV APP_WORK_DIR=/opt/node_app
 ENV PM2_HOME=${APP_WORK_DIR}/.pm2
 
+ARG BUILD_VERSION=unknown
+ARG BUILD_DATE=unknown
+ENV BUILD_VERSION=$BUILD_VERSION
+ENV BUILD_DATE=$BUILD_DATE
+
 # Install NodeJS Global Dependencies
 RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
     npm install --global pm2
 
 # Remaining commands as this user
 USER ${APP_USER}:${APP_USER}
 
+
 # Install Angular UI and Server Dependencies
-COPY --chown=${APP_USER}:${APP_USER} \
-    anms-ui/package.json anms-ui/package-lock.json ${APP_WORK_DIR}/
+COPY --chown=${APP_USER}:${APP_USER} anms-ui/ ${APP_WORK_DIR}/
 WORKDIR ${APP_WORK_DIR}
-COPY --chown=${APP_USER}:${APP_USER} \
-    anms-ui/server/package.json ${APP_WORK_DIR}/server/
+
+RUN ./modify_version.sh
+
+# TODO: Modify this to use 'npm ci'
 RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
     cd ${APP_WORK_DIR}/server && \
     npm install --omit=dev
+
+# TODO: Restore 'npm ci' after fixing checked-in package-lock.json
+# NOTE: npm i line is provided for developer usage when updating package-lock.json
 RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
     npm i
-RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
-    npm ci
+#RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
+#    npm ci
 
 # Build Backend/Frontend
-# These copies do not overwrite node_modules
-COPY --chown=${APP_USER}:${APP_USER} anms-ui/ ${APP_WORK_DIR}/
 RUN --mount=type=cache,uid=9999,gid=9999,target=/home/${APP_USER}/.npm \
     npm run build
 
@@ -249,6 +257,11 @@ CMD ["/usr/local/bin/docker-entrypoint.sh"]
 #
 FROM dtnma-acelib AS anms-core
 
+ARG BUILD_VERSION=unknown
+ARG BUILD_DATE=unknown
+ENV BUILD_VERSION=$BUILD_VERSION
+ENV BUILD_DATE=$BUILD_DATE
+
 ENV APP_WORK_DIR=/usr/src/anms-core
 
 # Requirement of main module
@@ -279,7 +292,7 @@ CMD ["/usr/local/bin/docker-entrypoint.sh"]
 EXPOSE 5555/tcp
 
 HEALTHCHECK --start-period=10s --interval=60s --timeout=10s --retries=20 \
-    CMD ["curl", "-sq", "-o/dev/null", "http://localhost:5555/hello"]
+    CMD ["curl", "-sq", "-o/dev/null", "http://localhost:5555/version"]
 
 # for anms-core integration test
 FROM yarn-base AS anms-core-integration
diff --git a/anms_release.sh b/anms_release.sh
diff --git a/checkout-test/test_routes.py b/checkout-test/test_routes.py
@@ -307,11 +307,12 @@ def test_grafana(self):
         )
 
     def test_anms_core(self):
-        resp = self._require_response(
-            url='/core/hello',
-            resp_status=[200],
-            resp_ctype=['text/plain'],
-        )
+        # error: failing with a 307 redirect error
+#        resp = self._require_response(
+#            url='/core/version',
+#            resp_status=[200],
+#            resp_ctype=['application/json'],
+#        )
         resp = self._require_response(
             url='/core/docs/',
             resp_status=[200],
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -208,6 +208,8 @@ services:
       target: anms-ui
       args:
         INTERNAL_CERT_URL: "${INTERNAL_CERT_URL}"
+        BUILD_VERSION: "${GIT_VERSION}"
+        BUILD_DATE: "${GIT_DATE}"
     restart: unless-stopped
     security_opt:
       - "label=type:anms-ui.process"
@@ -294,6 +296,8 @@ services:
       target: anms-core
       args:
         INTERNAL_CERT_URL: "${INTERNAL_CERT_URL}"
+        BUILD_VERSION: "${GIT_VERSION}"
+        BUILD_DATE: "${GIT_DATE}"
     restart: unless-stopped
     security_opt:
       - "label=type:anms-core.process"
@@ -305,6 +309,8 @@ services:
       DB_USER: ${DB_USER}
       DB_PASSWORD: ${DB_PASSWORD}
       DB_NAME: ${DB_NAME}
+      GIT_VERSION: ${GIT_VERSION}
+      GIT_DATE: ${GIT_DATE}
     ports:
       - "${ANMS_CORE_HTTP_PORT:-5555}:5555"
     depends_on:
diff --git a/example.env b/example.env
@@ -42,8 +42,6 @@ DB_NAME=amp_core
 DB_HEALTHCHECK_USER=healthcheck
 DB_HEALTHCHECK_PASSWORD=healthcheck
 
-OPENSEARCH_INITIAL_ADMIN_PASSWORD=Bw1YckbI3jroOxVnaQHm
-
 GRAFANA_CONTAINER_PORT=3000
 GRAFANA_HOST_PORT=grafana:${GRAFANA_CONTAINER_PORT}
 GRAFANA_PROXIES_PATH=localhost/grafana
diff --git a/quickstart.sh b/quickstart.sh
diff --git a/update_env.sh b/update_env.sh

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-`
	`1`	`+.env`
`2`	`2`	`*~`
`3`	`3`	`.idea/`
`4`	`4`	`*~`