Merge branch 'feature/PI-276-proxygen_spec' into release/2024-10-16

Author: jameslinnell

.github/workflows/_deploy.yml

@@ -145,6 +145,22 @@ jobs:
             infrastructure/swagger/dist/apigee/swagger.yaml
         if: ${{ always() }}
 
+  swagger--publish:
+    needs: [get-branch-from-workflow-file, apigee--deploy]
+    runs-on: [self-hosted, ci]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.get-branch-from-workflow-file.outputs.branch_name }}
+      # change below to (env.ACCOUNT == 'int') || (env.ACCOUNT == 'prod') when ready for prod
+      - if: (${{ env.SCOPE == 'per_workspace'}}) && (${{ env.ACCOUNT == 'int' }})
+        uses: ./.github/actions/make/
+        with:
+          command: swagger--publish
+          requires-aws: true
+          restore-from-cache: "true"
+          cache-suffix: ${{ env.CACHE_NAME }}
+
   test--smoke:
     needs: [get-branch-from-workflow-file, apigee--deploy]
     runs-on: [self-hosted, ci]
@@ -162,7 +178,7 @@ jobs:
 
   set-success:
     name: Set Success
-    needs: [test--smoke]
+    needs: [test--smoke, apigee--deploy]
     runs-on: [self-hosted, ci]
     steps:
       - name: Set success env var

scripts/infrastructure/apigee.mk

@@ -58,5 +58,3 @@ $(PROXYGEN_TIMESTAMP): aws--login $(SWAGGER_APIGEE) $(WORKSPACE_OUTPUT_JSON)
 	AWS_SECRET_ACCESS_KEY=$(AWS_SECRET_ACCESS_KEY) \
 	AWS_SESSION_TOKEN=$(AWS_SESSION_TOKEN) \
 		bash $(PATH_TO_INFRASTRUCTURE)/apigee/proxygen.sh generate_proxy
-
-	touch $(PROXYGEN_TIMESTAMP)

scripts/infrastructure/apigee/proxygen.sh

@@ -166,5 +166,51 @@ function delete_proxy(){
         --no-confirm
 }
 
+
+function publish_swagger(){
+    if [[ -z ${SWAGGER_PUBLIC} ]]; then
+        echo "SWAGGER_PUBLIC not set"
+        exit 1
+    fi
+
+
+    _workspace_name=$(get_workspace_name)
+    _aws_environment=$(get_aws_environment)
+    _apigee_environment=$(get_apigee_environment ${_workspace_name} ${_aws_environment})
+    _apigee_stage=$(get_apigee_stage ${_workspace_name})
+
+    if [[ ${_aws_environment} == "prod" ]]; then
+        _flags=""
+    #elif [[ ${_aws_environment} == "int" ]]; then
+    else
+        _flags="--uat"
+    # else
+    #     echo "ERROR: only environments to deploy to are 'prod' and 'int'"
+    #     exit 1;
+    fi
+
+        echo "
+    Publishing swagger
+    -------------------- ----------------------------------------
+    workspace_name        ${_workspace_name}
+    aws_environment       ${_aws_environment}
+    apigee_environment    ${_apigee_environment}
+    apigee_stage          ${_apigee_stage}
+    flags                 ${_flags}
+"
+
+    # Download the pem file if it does not exist
+    if [ ! -f "${APIGEE_CONFIG_PATH}/${_apigee_stage}/.proxygen/private_key.pem" ]; then
+        poetry run python ${PATH_TO_HERE}/download_pem.py ${_apigee_stage} ${APIGEE_DEPLOYMENT_ROLE}
+    fi
+
+    DOT_PROXYGEN=${APIGEE_CONFIG_PATH}/${_apigee_stage} \
+        poetry run \
+        python ${PATH_TO_HERE}/proxygen.py spec publish \
+        ${SWAGGER_PUBLIC} \
+        ${_flags} \
+        --no-confirm
+}
+
 # Expose functions publicly
 $@

scripts/infrastructure/swagger.mk

@@ -16,6 +16,8 @@ SWAGGER_AWS = $(SWAGGER_DIST)/aws/swagger.yaml
 SWAGGER_PUBLIC = $(SWAGGER_DIST)/public/swagger.yaml
 SWAGGER_APIGEE = $(SWAGGER_DIST)/apigee/swagger.yaml
 _CLEANED_SWAGGER_FILE = $(SWAGGER_DIST)/build/_02_clean.yaml
+PROXYGEN_TIMESTAMP = $(TIMESTAMP_DIR)/.proxygen.stamp
+SWAGGER_PUBLISH_TIMESTAMP = $(TIMESTAMP_DIR)/.swagger.publish.stamp
 
 TOOL_VERSIONS_COPY = $(TIMESTAMP_DIR)/tool-versions.copy
 SWAGGER_DEPENDENCIES = $(FHIR_BASE_TIMESTAMP) $(shell find infrastructure/swagger -type f -name "*.yaml" -not -path "*/dist/*.yaml" ) $(shell find scripts/infrastructure/swagger -type f -name "*.sh") $(TOOL_VERSIONS_COPY)
@@ -29,6 +31,8 @@ swagger--clean:  ## Removes swagger builds.
 	[[ -f $(PATH_TO_SWAGGER_GENERATOR_JAR) ]] && rm $(PATH_TO_SWAGGER_GENERATOR_JAR) || :
 swagger--generate-fhir-base: $(FHIR_BASE_TIMESTAMP)
 swagger--download-generator: $(PATH_TO_SWAGGER_GENERATOR_JAR)  ## Downloads the latest swagger fhir generator
+swagger--publish: $(SWAGGER_PUBLISH_TIMESTAMP) ## Publish swagger docs via proxygen to API Catalogue
+
 
 
 $(PATH_TO_SWAGGER_GENERATOR_JAR): $(INIT_TIMESTAMP)
@@ -61,3 +65,17 @@ $(SWAGGER_PUBLIC): $(SWAGGER_DEPENDENCIES) $(_CLEANED_SWAGGER_FILE)
 $(SWAGGER_APIGEE): $(SWAGGER_DEPENDENCIES) $(_CLEANED_SWAGGER_FILE) $(WORKSPACE_OUTPUT_JSON)
 	@env bash $(PATH_TO_INFRASTRUCTURE)/swagger/merge.sh generate_apigee_swagger
 	npx --yes @redocly/cli lint $(SWAGGER_APIGEE) --skip-rule security-defined || ([[ -f $(FHIR_BASE_TIMESTAMP) ]] && rm $(FHIR_BASE_TIMESTAMP) || :; exit 1)
+
+$(SWAGGER_PUBLISH_TIMESTAMP): aws--login $(SWAGGER_PUBLIC) $(WORKSPACE_OUTPUT_JSON)
+	[[ -f $(SWAGGER_PUBLISH_TIMESTAMP) ]] && rm $(SWAGGER_PUBLISH_TIMESTAMP) || :
+
+	WORKSPACE_OUTPUT_JSON=$(WORKSPACE_OUTPUT_JSON) \
+	ENVIRONMENT_MAPPING_YAML=$(ENVIRONMENT_MAPPING_YAML) \
+	STAGE_MAPPING_YAML=$(STAGE_MAPPING_YAML) \
+	APIGEE_CONFIG_PATH=$(APIGEE_CONFIG_PATH) \
+	SWAGGER_APIGEE=$(SWAGGER_APIGEE) \
+	SWAGGER_PUBLIC=$(SWAGGER_PUBLIC) \
+	AWS_ACCESS_KEY_ID=$(AWS_ACCESS_KEY_ID) \
+	AWS_SECRET_ACCESS_KEY=$(AWS_SECRET_ACCESS_KEY) \
+	AWS_SESSION_TOKEN=$(AWS_SESSION_TOKEN) \
+		bash $(PATH_TO_INFRASTRUCTURE)/apigee/proxygen.sh publish_swagger