feat: add integration tests

.github/workflows/deploy.yaml

@@ -0,0 +1,99 @@
+name: Deploy & Test Deployment
+
+permissions:
+  id-token: write  # required for requesting the JWT
+  contents: read  # required for actions/checkout
+
+on:
+  # run this workflow when the `Distribute` workflow completes
+  workflow_run:
+    workflows: [Distribute]
+    types: [completed]
+  # ... or manually. 
+  workflow_dispatch:
+
+  # remove later
+  push:
+    branches:
+      - "feat/add-integration-tests"
+
+jobs:
+  # run a job on a successful `Workflow` run. 
+  on-successful-release:
+    runs-on: ubuntu-latest
+    env:
+      AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION_DEPLOY }}
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID_DEPLOY }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_DEPLOY }}
+
+
+    steps:
+
+    - name: Checkout repository # for runs after `Distribute`, pulling from main will always give the latest eoapi-cdk. 
+      uses: actions/checkout@v3
+
+    - name: Set up python
+      uses: actions/setup-python@v2
+      with:
+        cache: pip
+
+    - name: Set up node
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+
+    - name: Install deployment environment
+      working-directory: integration_tests/cdk
+      run: |
+        python -m venv .deployment_venv
+        source .deployment_venv/bin/activate
+        pip install -r requirements.txt
+        pip install --upgrade eoapi-cdk # make sure to take the latest version of eoapi-cdk since we're integration-testing the newest release. 
+        npm install
+        deactivate
+
+    - name: Synthesize the stack
+      working-directory: integration_tests/cdk
+      run: |
+        source .deployment_venv/bin/activate
+        npx cdk synth --debug --all --require-approval never
+        deactivate
+
+    # deploys and grabs URLs from the output for later tests
+    - name: Deploy the stack
+      id: deploy_step
+      working-directory: integration_tests/cdk
+      run: |
+        source .deployment_venv/bin/activate
+        npx cdk deploy --ci --all --require-approval never
+        echo "ingestor_url=$(aws cloudformation describe-stacks --stack-name eoapi-template-demo-test-pgSTAC-infra --query "Stacks[0].Outputs[?starts_with(OutputKey, 'stacingestor')].OutputValue | [0]" --output text)" >> $GITHUB_OUTPUT
+        echo "stac_api_url=$(aws cloudformation describe-stacks --stack-name eoapi-template-demo-test-pgSTAC-infra --query "Stacks[0].Outputs[?starts_with(OutputKey, 'pgstacapi')].OutputValue | [0]" --output text)" >> $GITHUB_OUTPUT
+        echo "titiler_pgstac_api_url=$(aws cloudformation describe-stacks --stack-name eoapi-template-demo-test-pgSTAC-infra --query "Stacks[0].Outputs[?starts_with(OutputKey, 'titilerpgstac')].OutputValue | [0]" --output text)" >> $GITHUB_OUTPUT
+        deactivate
+
+    - name: Install test environment
+      working-directory: integration_tests/tests
+      run: |
+        python -m venv .tests_venv
+        source .tests_venv/bin/activate
+        pip install -r requirements.txt
+        deactivate
+
+    - name: Test the stack
+      working-directory: integration_tests/tests
+      env:
+        ingestor_url: ${{ steps.deploy_step.outputs.ingestor_url }}
+        stac_api_url: ${{ steps.deploy_step.outputs.stac_api_url }}
+        titiler_pgstac_api_url: ${{ steps.deploy_step.outputs.titiler_pgstac_api_url }}
+      run: |
+        source .tests_venv/bin/activate
+        pytest eoapi_tests
+        deactivate
+
+    - name: Always tear down the stack
+      if: always()
+      working-directory: integration_tests/cdk
+      run: |
+        source .deployment_venv/bin/activate
+        npx cdk destroy --ci --all --force
+        deactivate

.gitignore

@@ -8,3 +8,6 @@ docs
 __pycache__
 .venv
 .tox
+tests/*.egg*
+tests/*venv*
+tests/__pycache__

README.md

@@ -54,3 +54,6 @@ Versioning is automatically handled via [Conventional Commits](https://www.conve
 _Warning_: If you rebase `main`, you must ensure that the commits referenced by tags point to commits that are within the `main` branch. If a commit references a commit that is no longer on the `main` branch, Semantic Release will fail to detect the correct version of the project. [More information](https://github.com/semantic-release/semantic-release/issues/1121#issuecomment-517945233).
 
 
+## Tests
+
+Each new release triggers an integration test against a running deployment that uses the newly releases constructs. See the corresponding [github workflow](https://github.com/developmentseed/eoapi-cdk/blob/main/.github/workflows/deploy.yaml) and the [tests definition](https://github.com/developmentseed/eoapi-cdk/blob/main/tests).

integration_tests/cdk/README.md

@@ -0,0 +1,49 @@
+This is a non-forked version of [eoapi-template](https://github.com/developmentseed/eoapi-template).
+
+# Deployment CDK code for eoapi-cdk integration tests
+
+This is a wrapper CDK code that provides the `eoapi-cdk` deployment to run integration tests on the latest releases of the `eoapi-cdk` constructs.
+
+## Requirements
+
+- python
+- docker
+- node
+- AWS credentials environment variables configured to point to an account. 
+- **Optional** a `config.yaml` file to override the default deployment settings defined in `config.py`.
+
+## Installation
+
+Install python dependencies with 
+
+```
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -r requirements.txt
+```
+
+Note that `eoapi-cdk` isn't pinned, so that the latest version is always installed. Also install node dependencies with 
+
+```
+npm install
+```
+
+Verify that the `cdk` CLI is available. Since `aws-cdk` is installed as a local dependency, you can use the `npx` node package runner tool, that comes with `npm`.
+
+```
+npx cdk --version
+```
+
+## Deployment
+
+First, synthesize the app 
+
+```
+npx cdk synth --all
+```
+
+Then, deploy
+
+```
+npx cdk deploy --all --require-approval never
+```

integration_tests/cdk/app.py

@@ -0,0 +1,17 @@
+from aws_cdk import App
+
+from config import build_app_config
+from eoapi_template import pgStacInfra, vpc
+
+app = App()
+
+app_config = build_app_config()
+
+vpc_stack = vpc.VpcStack(scope=app, app_config=app_config)
+
+pgstac_infra_stack = pgStacInfra.pgStacInfraStack(
+    scope=app,
+    vpc=vpc_stack.vpc,
+    app_config=app_config,
+)
+app.synth()

integration_tests/cdk/cdk.json

@@ -0,0 +1,32 @@
+{
+  "app": "python3 app.py",
+  "watch": {
+    "include": [
+      "**"
+    ],
+    "exclude": [
+      "README.md",
+      "cdk*.json",
+      "requirements*.txt",
+      "source.bat",
+      "**/*.pyc",
+      "**/*.tmp",
+      "**/__pycache__",
+      "tests",
+      "scripts",
+      "*venv"
+    ]
+  },
+  "context": {
+    "@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId": true,
+    "@aws-cdk/core:stackRelativeExports": true,
+    "@aws-cdk/aws-rds:lowercaseDbIdentifier": true,
+    "@aws-cdk/aws-lambda:recognizeVersionProps": true,
+    "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
+    "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+    "@aws-cdk/core:target-partitions": [
+      "aws",
+      "aws-cn"
+    ]
+  }
+}