snowballtools-base/packages/deployer/test/README.md

# deployer test

Check if the live web app deployer is in a working state

- Web app repo used: <https://github.com/snowball-tools/test-progressive-web-app> (main branch)
- Config used: [../config.yml](../config.yml)
- The script [test-webapp-deployment-undeployment.sh](./test-webapp-deployment-undeployment.sh) performs the following:
  - Create / update [`ApplicationRecord`](./records/application-record.yml) and [`ApplicationDeploymentRequest`](./records/application-deployment-request.yml) records with latest meta data from the repo
  - Fetch the latest version of `deployment-test-app` from registry and increment `ApplicationRecord` version
  - Publish the resulting `ApplicationRecord` record
  - Set names to the record and check name resolution
  - Publish the `ApplicationDeploymentRequest` record
  - Check that the deployment occurs
    - Check that a `ApplicationDeploymentRecord` is created
    - Check that the deployment record has correct `ApplicationRecord` id
    - Check that the URL present in deployment record is active
  - Create and publish a [`ApplicationDeploymentRemovalRequest`](./records/application-deployment-removal-request.yml) record
  - Check that the deployment is removed
    - Check that a `ApplicationDeploymentRemovalRecord` is created
    - Check that the deployment URL goes down
- The test script is run in a GitHub CI [workflow](../../../.github/workflows/test-app-deployment.yaml) that:
  - Is scheduled to run everyday on the default (`main`) branch or can be triggered manually
  - Sends Slack alerts to configured channels on failure
Add CI to test web app deployment and undeployment (#174) * Add a script to deploy test records * Add checks for ApplicationDeploymentRecord and the deployment URL * Add a CI workflow to run the app deployment test * Update test deployment request record config * Add test for deployment removal * Update test deployment request record * Increase max retries * Add retries when checking if URL is up or down * Rename test script * Run webapp deployment test CI on PR * Remove unnecessary jq installation step from CI * Revert "Run webapp deployment test CI on PR" This reverts commit 01f373501a95b95cf0abc1dee8fed639ec62daf5. * Add a step for Slack alerts on a CI failure * Add a workflow dispatch for manual trigger * Update workflow title and remove trigger on main * Document deployment test setup --------- Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com> 2024-04-15 08:40:59 +00:00			`# deployer test`

			`Check if the live web app deployer is in a working state`

fix(staging): github client id on frontend staging deployment script (#214) ### TL;DR Update references to the new GitHub repository URLs and make minor formatting fixes in deployment scripts. ### What changed? Updated GitHub repository URLs from `snowball-tools-platform` to `snowball-tools` in various deployment and test scripts. Made minor formatting adjustments including spacing and indentation. ### How to test? Run the deployment scripts in their respective environments to ensure they reference the correct repository URLs and all functionalities work as expected. Check for successful creation and updation of application records. ### Why make this change? This change was made to reflect the new repository structure and ensure consistency across all deployment scripts. The minor formatting fixes improve code readability. --- 2024-06-22 21:24:40 +00:00			`- Web app repo used: <https://github.com/snowball-tools/test-progressive-web-app> (main branch)`
Add CI to test web app deployment and undeployment (#174) * Add a script to deploy test records * Add checks for ApplicationDeploymentRecord and the deployment URL * Add a CI workflow to run the app deployment test * Update test deployment request record config * Add test for deployment removal * Update test deployment request record * Increase max retries * Add retries when checking if URL is up or down * Rename test script * Run webapp deployment test CI on PR * Remove unnecessary jq installation step from CI * Revert "Run webapp deployment test CI on PR" This reverts commit 01f373501a95b95cf0abc1dee8fed639ec62daf5. * Add a step for Slack alerts on a CI failure * Add a workflow dispatch for manual trigger * Update workflow title and remove trigger on main * Document deployment test setup --------- Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com> 2024-04-15 08:40:59 +00:00			`- Config used: [../config.yml](../config.yml)`
			`- The script [test-webapp-deployment-undeployment.sh](./test-webapp-deployment-undeployment.sh) performs the following:`
			- Create / update [`ApplicationRecord`](./records/application-record.yml) and [`ApplicationDeploymentRequest`](./records/application-deployment-request.yml) records with latest meta data from the repo
			- Fetch the latest version of `deployment-test-app` from registry and increment `ApplicationRecord` version
			- Publish the resulting `ApplicationRecord` record
			`- Set names to the record and check name resolution`
			- Publish the `ApplicationDeploymentRequest` record
			`- Check that the deployment occurs`
			- Check that a `ApplicationDeploymentRecord` is created
			- Check that the deployment record has correct `ApplicationRecord` id
			`- Check that the URL present in deployment record is active`
			- Create and publish a [`ApplicationDeploymentRemovalRequest`](./records/application-deployment-removal-request.yml) record
			`- Check that the deployment is removed`
			- Check that a `ApplicationDeploymentRemovalRecord` is created
			`- Check that the deployment URL goes down`
			`- The test script is run in a GitHub CI [workflow](../../../.github/workflows/test-app-deployment.yaml) that:`
			- Is scheduled to run everyday on the default (`main`) branch or can be triggered manually
			`- Sends Slack alerts to configured channels on failure`