PromucFlow_constructor/.github/workflows/test-build-docker-image.yml
Abhijeet 115ed5af41
chore: Trigger TBP on pg for scheduled run on release (#36399)
## Description
We want to trigger TBP workflow on pg on a scheduled basis similar to
what we have for release branch to be aware of failures on pg branch
because of the continuous merges from release. We searched if scheduled
job can be triggered for non default branch but that is not possible.
With this PR we are adding a job in the workflow to trigger the
`workflow_dispatch` event with ref to pg branch. Other options which we
may want to explore is [reusable
workflows](https://docs.github.com/en/actions/sharing-automations/reusing-workflows).

/test sanity

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]  
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.

<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a new job for handling PostgreSQL workflows during release
events.
- **Changes**
	- Removed the `is-pg-build` parameter from the build workflow.
- Simplified the CI process by limiting job triggers to the `master`
branch.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-09-19 22:34:52 +05:30

485 lines
18 KiB
YAML

name: Test, build and push Docker Image
run-name: >
${{ github.workflow }} with TED:${{ inputs.ted_tag || 'latest' }}
on:
# This workflow will run everyday at 7:00AM, 1:00PM IST on weekdays
schedule:
- cron: "30 1-12/6 * * 1-5"
# This line enables manual triggering of this workflow.
workflow_dispatch:
inputs:
tags:
description: "Tags"
required: false
type: string
default: ""
ted_tag:
description: TestEventDriver image tag
required: false
type: string
default: latest
# trigger for pushes to master and pg
push:
branches: [master]
paths:
- "app/client/**"
- "app/server/**"
- "app/client/packages/rts/**"
- "!app/client/cypress/manual_TestSuite/**"
jobs:
setup:
runs-on: ubuntu-latest
outputs:
tags: ${{ steps.setup.outputs.tags }}
matrix: ${{ steps.setup.outputs.matrix }}
steps:
- name: "Post inputs to run summary"
env:
INPUTS: "${{ toJSON(inputs) }}"
run: |
echo $'## Inputs\n```\n'"$INPUTS"$'\n```' > "$GITHUB_STEP_SUMMARY"
- name: Set tags and matrix runner
id: setup
run: |
if [ "${{github.event_name}}" == "workflow_dispatch" ]; then
if [[ "${{inputs.tags}}" != "" && "${{inputs.tags}}" != *"@tag.All"* ]]; then
echo "tags=${{inputs.tags}}" >> $GITHUB_OUTPUT
echo "matrix=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]" >> $GITHUB_OUTPUT
else
echo "tags=" >> $GITHUB_OUTPUT
echo "matrix=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59]" >> $GITHUB_OUTPUT
fi
else
echo "tags=" >> $GITHUB_OUTPUT
echo "matrix=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59]" >> $GITHUB_OUTPUT
fi
invoke-tbp-workflow-for-pg:
needs: [setup]
if: github.event_name != 'push' && github.ref == 'refs/heads/release'
uses: benc-uk/workflow-dispatch@v1
with:
workflow: test-build-docker-image.yml
inputs: '{ "ref": "pg"}'
server-build:
needs: [setup]
if: success()
name: server-build
uses: ./.github/workflows/server-build.yml
secrets: inherit
with:
pr: 0
skip-tests: true
client-build:
needs: [setup]
if: success()
name: client-build
uses: ./.github/workflows/client-build.yml
secrets: inherit
with:
pr: 0
rts-build:
needs: [setup]
if: success()
name: rts-build
uses: ./.github/workflows/rts-build.yml
secrets: inherit
with:
pr: 0
build-docker-image:
needs: [client-build, server-build, rts-build]
# Only run if the build step is successful
if: success()
name: build-docker-image
uses: ./.github/workflows/build-docker-image.yml
secrets: inherit
with:
pr: 0
ci-test:
needs: [setup, build-docker-image]
# Only run if the build step is successful
if: success() && ( github.event_name != 'push' || github.ref == 'refs/heads/master')
name: ci-test
uses: ./.github/workflows/ci-test-custom-script.yml
secrets: inherit
with:
pr: 0
tags: ${{needs.setup.outputs.tags}}
matrix: ${{needs.setup.outputs.matrix}}
ted_tag: ${{inputs.ted_tag}}
server-unit-tests:
name: server-unit-tests
needs: [build-docker-image]
if: success() && ( github.event_name != 'push' || github.ref == 'refs/heads/master')
uses: ./.github/workflows/server-build.yml
secrets: inherit
with:
pr: 0
skip-tests: false
is-pg-build: ${{ github.ref == 'refs/heads/pg' }}
client-unit-tests:
name: client-unit-tests
needs: [build-docker-image]
if: success() && ( github.event_name != 'push' || github.ref == 'refs/heads/master')
uses: ./.github/workflows/client-unit-tests.yml
secrets: inherit
with:
pr: 0
ci-test-result:
needs: [ci-test, client-unit-tests, server-unit-tests]
if: always() &&
(github.event_name == 'workflow_dispatch' ||
github.event_name == 'schedule' ||
( github.event_name != 'push' || github.ref == 'refs/heads/master' ) ||
(github.event_name == 'pull_request_review' &&
github.event.review.state == 'approved' &&
github.event.pull_request.head.repo.full_name == github.repository))
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- run: echo "All ci-test matrices completed"
# Deleting the existing dir's if any
- name: Delete existing directories
if: needs.ci-test.result != 'success'
run: |
rm -f ~/failed_spec_ci
rm -f ~/combined_failed_spec_ci
# Download failed_spec_ci list for all CI container jobs
- name: Download failed_spec_ci list for all CI container jobs
uses: actions/download-artifact@v4
if: needs.ci-test.result != 'success'
id: download_ci
with:
name: failed-spec-ci-${{github.run_attempt}}
path: ~/failed_spec_ci
# In case for any ci job failure, create combined failed spec
- name: Combine all specs for CI
if: needs.ci-test.result != 'success'
run: |
rm -f ~/combined_failed_spec_ci
cat ~/failed_spec_ci/failed_spec_ci* >> ~/combined_failed_spec_ci
- name: CI test failures
if: needs.ci-test.result != 'success'
shell: bash
run: |
new_failed_spec_env="<ol>$(sort -u ~/combined_failed_spec_ci | sed 's/|cypress|cypress/<\/li>\n<li>/g' | sed -e 's/^<li>//' -e 's/<\/li>$//' -e 's/<\/li>/<\/li>\n/')</ol>"
echo "$new_failed_spec_env"
echo "new_failed_spec_env<<EOF" >> $GITHUB_ENV
echo "$new_failed_spec_env" >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
- name: Generate slack message
continue-on-error: true
if: always()
id: slack_notification
env:
EVENT_COMMITS: ${{ toJson(github.event.commits[0].message) }}
run: |
eventCommit=$(echo ${{env.EVENT_COMMITS}} | sed "s/'//g")
echo "slack_username=$(echo "$eventCommit" | awk -F '\\\\n' '{print $1}' | sed 's/^"//;s/"$//')" >> $GITHUB_OUTPUT
if [[ ${{ needs.ci-test.result }} == 'failure' ]]; then
echo "slack_message=There are test failures in the run. Cypress Dashboard: <https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=${{ github.run_id }}&attempt=${{ github.run_attempt }}&selectiontype=test&testsstatus=failed&specsstatus=fail|Click here!>" >> $GITHUB_OUTPUT
echo "slack_color=#FF0000" >> $GITHUB_OUTPUT
echo "slack_icon=:no_entry:" >> $GITHUB_OUTPUT
elif [[ ${{ needs.ci-test.result }} == 'success' ]]; then
echo "slack_message=All tests passed successfully :tada: Cypress Dashboard: <https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=${{ github.run_id }}&attempt=${{ github.run_attempt }}|Click here!>" >> $GITHUB_OUTPUT
echo "slack_color=#00FF00" >> $GITHUB_OUTPUT
echo "slack_icon=:white_check_mark:" >> $GITHUB_OUTPUT
else
echo "slack_message=There are build failures. To analyze run go <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|here>" >> $GITHUB_OUTPUT
echo "slack_color=#FF0000" >> $GITHUB_OUTPUT
echo "slack_icon=:warning:" >> $GITHUB_OUTPUT
fi
- name: Slack notification
continue-on-error: true
if: always()
uses: rtCamp/action-slack-notify@v2
env:
SLACK_CHANNEL: cypresspushworkflow
SLACK_COLOR: ${{steps.slack_notification.outputs.slack_color}}
SLACK_ICON_EMOJI: ${{steps.slack_notification.outputs.slack_icon}}
SLACK_ICON: https://app.slack.com/services/B05D17E4QVB
SLACK_TITLE: "Result:"
SLACK_USERNAME: ${{steps.slack_notification.outputs.slack_username}}
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_HOSTED }}
MSG_MINIMAL: Ref,Event,Commit
SLACK_FOOTER: "Push Workflow"
SLACK_MESSAGE: ${{steps.slack_notification.outputs.slack_message}}
# Dump github context for future use
- name: Dump GitHub context
env:
GITHUB_CONTEXT: ${{ toJSON(github) }}
run: |
echo "$GITHUB_CONTEXT"
echo ${{ github.repository }}
# This step triggers an external workflow for automated analysis of Cypress test runs.
- name: Invoke Automated analysis workflow
if: ( always() && github.ref == 'refs/heads/release' && github.run_attempt <= 2)
run: |
curl --location --request POST ${{secrets.CYPRESS_WORKFLOW_API}} \
--header 'x-appsmith-key: ${{ secrets.CYPRESS_WORKFLOW_KEY }}' \
--header 'Content-Type: application/json' \
--data-raw '{ "workflow_id" : ${{ github.run_id }} ,
"commit_id" : "${{ github.sha }}" ,
"repo" : "${{ github.event.repository.full_name }}" ,
"task" : "${{ github.job }}" ,
"workflow_type" : "${{ github.event_name }}",
"workflow_name" : "TBD",
"job_id" : "",
"attempt" : "${{ github.run_attempt }}",
"job_data": {
"ci_test_result_sample_data" : "sample_data"
}
}'
# Force save the CI failed spec list into a cache
- name: Store the combined run result for CI
if: needs.ci-test.result != 'success'
uses: actions/cache/save@v4
with:
path: |
~/combined_failed_spec_ci
key: ${{ github.run_id }}-"ci-test-result"
# Upload combined failed CI spec list to a file
# This is done for debugging.
- name: Upload combined failed spec
if: needs.ci-test.result != 'success'
uses: actions/upload-artifact@v4
with:
name: combined_failed_spec_ci
path: ~/combined_failed_spec_ci
overwrite: true
- name: Return status for ui-matrix
run: |
if [[ "${{ needs.ci-test.result }}" == "success" && "${{ needs.client-unit-tests.result }}" == "success" && "${{ needs.server-unit-tests.result }}" == "success" ]]; then
echo "Integration, Client unit and Server unit tests completed successfully!";
exit 0;
elif [[ "${{ needs.ci-test.result }}" == "skipped" ]]; then
echo "Integration tests were skipped";
exit 1;
elif [[ "${{ needs.client-unit-tests.result }}" == "skipped" ]]; then
echo "Client unit tests were skipped";
exit 1;
elif [[ "${{ needs.server-unit-tests.result }}" == "skipped" ]]; then
echo "Server unit tests were skipped";
exit 1;
elif [[ "${{ needs.client-unit-tests.result }}" == "failure" ]]; then
echo "Client unit tests have failed";
exit 1;
elif [[ "${{ needs.server-unit-tests.result }}" == "failure" ]]; then
echo "Server unit tests have failed";
exit 1;
else
echo "Integration tests have failed";
exit 1;
fi
package-release:
needs: build-docker-image
runs-on: ubuntu-latest
# Set permissions since we're using OIDC token authentication between Depot and GitHub
permissions:
contents: read
id-token: write
# Run this job as soon as the docker image is ready, if this is the release branch
if: ( always() && github.ref == 'refs/heads/release' )
steps:
- name: Checkout the head commit of the branch
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule'
uses: actions/checkout@v4
- name: Download the react build artifact
uses: actions/download-artifact@v4
with:
name: client-build
path: app/client
- name: Unpack the client build artifact
if: steps.run_result.outputs.run_result != 'success'
run: |
mkdir -p app/client/build
tar -xvf app/client/build.tar -C app/client/build
- name: Download the server build artifact
uses: actions/download-artifact@v4
with:
name: server-build
path: app/server/dist
- name: Download the rts build artifact
uses: actions/download-artifact@v4
with:
name: rts-dist
path: app/client/packages/rts/dist
- name: Untar the rts folder
run: |
tar -xvf app/client/packages/rts/dist/rts-dist.tar -C app/client/packages/rts/
echo "Cleaning up the tar files"
rm app/client/packages/rts/dist/rts-dist.tar
- name: Generate info.json
run: |
if [[ -f scripts/generate_info_json.sh ]]; then
scripts/generate_info_json.sh
fi
- name: Place server artifacts-es
run: |
if [[ -f scripts/prepare_server_artifacts.sh ]]; then
scripts/prepare_server_artifacts.sh
fi
- name: Set up Depot CLI
uses: depot/setup-action@v1
- name: Login to DockerHub
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
- name: Build and push release image to Docker Hub
if: success()
uses: depot/build-push-action@v1
with:
context: .
push: true
platforms: linux/arm64,linux/amd64
build-args: |
APPSMITH_SEGMENT_CE_KEY=${{ secrets.APPSMITH_SEGMENT_CE_KEY_RELEASE }}
APPSMITH_CLOUD_SERVICES_BASE_URL=https://release-cs.appsmith.com
BASE=${{ vars.DOCKER_HUB_ORGANIZATION }}/base-${{ vars.EDITION }}:release
tags: |
${{ vars.DOCKER_HUB_ORGANIZATION }}/appsmith-${{ vars.EDITION }}:${{ github.ref_name }}
package-master:
needs: [ci-test, client-unit-tests, server-unit-tests]
runs-on: ubuntu-latest
# Set permissions since we're using OIDC token authentication between Depot and GitHub
permissions:
contents: read
id-token: write
# Run this job irrespective of tests failing, if this is the release branch; or only if the tests pass, if this is the master branch.
if: ( success() && github.ref == 'refs/heads/master' )
steps:
- name: Checkout the head commit of the branch
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
uses: actions/checkout@v4
- name: Download the react build artifact
uses: actions/download-artifact@v4
with:
name: client-build
path: app/client
- name: Unpack the client build artifact
if: steps.run_result.outputs.run_result != 'success'
run: |
mkdir -p app/client/build
tar -xvf app/client/build.tar -C app/client/build
- name: Download the server build artifact
uses: actions/download-artifact@v4
with:
name: server-build
path: app/server/dist
- name: Download the rts build artifact
uses: actions/download-artifact@v4
with:
name: rts-dist
path: app/client/packages/rts/dist
- name: Untar the rts folder
run: |
tar -xvf app/client/packages/rts/dist/rts-dist.tar -C app/client/packages/rts/
echo "Cleaning up the tar files"
rm app/client/packages/rts/dist/rts-dist.tar
- name: Generate info.json
run: |
if [[ -f scripts/generate_info_json.sh ]]; then
scripts/generate_info_json.sh
fi
- name: Set up Depot CLI
uses: depot/setup-action@v1
- name: Login to DockerHub
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
- name: Build and push master image to Docker Hub with commit tag
if: success()
uses: depot/build-push-action@v1
with:
context: .
push: true
platforms: linux/arm64,linux/amd64
build-args: |
APPSMITH_SEGMENT_CE_KEY=${{ secrets.APPSMITH_SEGMENT_CE_KEY }}
BASE=${{ vars.DOCKER_HUB_ORGANIZATION }}/base-${{ vars.EDITION }}:nightly
tags: |
${{ vars.DOCKER_HUB_ORGANIZATION }}/appsmith-${{ vars.EDITION }}:${{ github.sha }}
${{ vars.DOCKER_HUB_ORGANIZATION }}/appsmith-${{ vars.EDITION }}:nightly
notify-slack-for-promotion:
needs: ci-test-result
runs-on: ubuntu-latest
if: ( failure() && github.ref == 'refs/heads/master' )
steps:
- name: Notify failure on workflow run and on Slack
run: |
set -o errexit
set -o nounset
set -o xtrace
run_url='${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/attempts/${{ github.run_attempt }}'
slack_message="🚨 TBP workflow failed in <$run_url|${{ vars.EDITION }} attempt ${{ github.run_attempt }} (run ${{ github.run_id }})>."
# This is the ChannelId of the tech channel.
body="$(jq -nc \
--arg channel CGBPVEJ5C \
--arg text "$slack_message" \
'$ARGS.named'
)"
curl -v https://slack.com/api/chat.postMessage \
--fail-with-body \
--header 'Authorization: Bearer ${{ secrets.SLACK_APPSMITH_ALERTS_TOKEN }}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw "$body"