SANDBOX-1371: prepare enablement of ui e2e tests #1180
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| name: publish-operators-for-ui-e2e-tests | ||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
| pull_request_target: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| env: | ||
| GOPATH: /tmp/go | ||
|
|
||
| jobs: | ||
| binary: | ||
| name: Build & push operator bundles for UI e2e tests | ||
|
|
||
| runs-on: ubuntu-24.04 | ||
| if: ${{ github.event.comment == '' || contains(github.event.comment.body, '/retest') || contains(github.event.comment.body, '/test all') || contains(github.event.comment.body, '/test e2e') }} | ||
| steps: | ||
| # Checkout from PR event - in that case the comment field is empty | ||
| - name: Checkout code from PR event | ||
| uses: actions/checkout@v4 | ||
| if: ${{ github.event.comment == '' }} | ||
| with: | ||
| ref: ${{github.event.pull_request.head.ref}} | ||
| repository: ${{github.event.pull_request.head.repo.full_name}} | ||
| fetch-depth: 0 | ||
|
|
||
| # If the workflow was triggered based on comment, then we need to get the information about the PR | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Send Github API Request to get PR data | ||
| id: request | ||
| uses: octokit/request-action@v2.4.0 | ||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| route: ${{ github.event.issue.pull_request.url }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| # Checkout the code based on the data retrieved from the previous step | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Checkout code from PR | ||
| uses: actions/checkout@v4 | ||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| repository: ${{ fromJson(steps.request.outputs.data).head.repo.full_name }} | ||
| ref: ${{ fromJson(steps.request.outputs.data).head.ref }} | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: go.mod | ||
|
|
||
| - name: Cache dependencies | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/go/pkg/mod | ||
| key: ${{ runner.os }}-go-${{ hashFiles ('**/go.sum') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-go- | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.x' | ||
|
|
||
| - name: Prepare tools | ||
| uses: codeready-toolchain/toolchain-cicd/prepare-tools-action@master | ||
|
|
||
| # Execute composite action using values from PR event | ||
| # Is executed only for PR events - in that case the comment field is empty | ||
| - name: Publish current operator bundles for host & member based on PR event | ||
| uses: rsoaresd/toolchain-cicd/publish-operators-for-ui-e2e-tests@add_actions_to_ui_e2e_tests | ||
| if: ${{ github.event.comment == '' }} | ||
| with: | ||
| quay-token: ${{ secrets.TEST_QUAY_TOKEN }} | ||
| quay-namespace: codeready-toolchain-test | ||
| sha: ${{ github.event.pull_request.head.sha }} | ||
| pr-number: ${{ github.event.pull_request.number }} | ||
| author: ${{ github.event.pull_request.head.user.login }} | ||
| gh-head-ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| # Execute composite action using values from PR event | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Publish current operator bundles for host & member based on comment event | ||
| uses: rsoaresd/toolchain-cicd/publish-operators-for-ui-e2e-tests@add_actions_to_ui_e2e_tests | ||
|
Contributor
Author
There was a problem hiding this comment. temporary, just to test |
||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| quay-token: ${{ secrets.TEST_QUAY_TOKEN }} | ||
| quay-namespace: codeready-toolchain-test | ||
| sha: ${{ fromJson(steps.request.outputs.data).head.sha }} | ||
| pr-number: ${{ fromJson(steps.request.outputs.data).number }} | ||
| author: ${{ fromJson(steps.request.outputs.data).head.user.login }} | ||
| gh-head-ref: ${{ fromJson(steps.request.outputs.data).head.ref }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| name: publish-sandbox-ui-for-ui-e2e-tests | ||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
| pull_request_target: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| env: | ||
| GOPATH: /tmp/go | ||
|
|
||
| jobs: | ||
| binary: | ||
| name: Build & push Developer Sandbox UI image for UI e2e tests | ||
|
|
||
| runs-on: ubuntu-24.04 | ||
| if: ${{ github.event.comment == '' || contains(github.event.comment.body, '/retest') || contains(github.event.comment.body, '/test all') || contains(github.event.comment.body, '/test e2e') }} | ||
| steps: | ||
| # Checkout from PR event - in that case the comment field is empty | ||
| - name: Checkout code from PR event | ||
| uses: actions/checkout@v4 | ||
| if: ${{ github.event.comment == '' }} | ||
| with: | ||
| ref: ${{github.event.pull_request.head.ref}} | ||
| repository: ${{github.event.pull_request.head.repo.full_name}} | ||
| fetch-depth: 0 | ||
|
|
||
| # If the workflow was triggered based on comment, then we need to get the information about the PR | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Send Github API Request to get PR data | ||
| id: request | ||
| uses: octokit/request-action@v2.4.0 | ||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| route: ${{ github.event.issue.pull_request.url }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| # Checkout the code based on the data retrieved from the previous step | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Checkout code from PR | ||
| uses: actions/checkout@v4 | ||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| repository: ${{ fromJson(steps.request.outputs.data).head.repo.full_name }} | ||
| ref: ${{ fromJson(steps.request.outputs.data).head.ref }} | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: go.mod | ||
|
|
||
| - name: Cache dependencies | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/go/pkg/mod | ||
| key: ${{ runner.os }}-go-${{ hashFiles ('**/go.sum') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-go- | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.x' | ||
|
|
||
| - name: Prepare tools | ||
| uses: codeready-toolchain/toolchain-cicd/prepare-tools-action@master | ||
|
|
||
| # Execute composite action using values from PR event | ||
| # Is executed only for PR events - in that case the comment field is empty | ||
| - name: Publish current Developer Sandbox UI image | ||
| uses: rsoaresd/toolchain-cicd/publish-sandbox-ui-for-ui-e2e-tests@add_actions_to_ui_e2e_tests | ||
|
Contributor
Author
There was a problem hiding this comment. temporary, just to test |
||
| if: ${{ github.event.comment == '' }} | ||
| with: | ||
| quay-token: ${{ secrets.TEST_QUAY_TOKEN }} | ||
| quay-namespace: codeready-toolchain-test | ||
| sha: ${{ github.event.pull_request.head.sha }} | ||
| pr-number: ${{ github.event.pull_request.number }} | ||
| author: ${{ github.event.pull_request.head.user.login }} | ||
| gh-head-ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| # Execute composite action using values from PR event | ||
| # Is executed only for comment events - in that case the pull_request field is empty | ||
| - name: Publish current Developer Sandbox UI image | ||
| uses: rsoaresd/toolchain-cicd/publish-sandbox-ui-for-ui-e2e-tests@add_actions_to_ui_e2e_tests | ||
|
Contributor
Author
There was a problem hiding this comment. temporary, just to test |
||
| if: ${{ github.event.pull_request == '' }} | ||
| with: | ||
| quay-token: ${{ secrets.TEST_QUAY_TOKEN }} | ||
| quay-namespace: codeready-toolchain-test | ||
| sha: ${{ fromJson(steps.request.outputs.data).head.sha }} | ||
| pr-number: ${{ fromJson(steps.request.outputs.data).number }} | ||
| author: ${{ fromJson(steps.request.outputs.data).head.user.login }} | ||
| gh-head-ref: ${{ fromJson(steps.request.outputs.data).head.ref }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,11 +4,30 @@ TAG := latest | |
| PLATFORM ?= linux/amd64 | ||
| RHDH_PLUGINS_DIR ?= $(TMPDIR)rhdh-plugins | ||
| AUTH_FILE := /tmp/auth.json | ||
| OPENID_SECRET_NAME=openid-sandbox-public-client-secret | ||
| PUSH_SANDBOX_IMAGE ?= true | ||
| UI_ENVIRONMENT := ui-e2e-tests | ||
|
|
||
| TAG := $(shell \ | ||
| if [ -n "$(CI)$(CLONEREFS_OPTIONS)" ]; then \ | ||
| if [ -n "$(GITHUB_ACTIONS)" ]; then \ | ||
| REPOSITORY_NAME=$$(basename "$(GITHUB_REPOSITORY)"); \ | ||
| COMMIT_ID_SUFFIX=$$(echo "$(PULL_PULL_SHA)" | cut -c1-7); \ | ||
| echo "from.$${REPOSITORY_NAME}.PR$(PULL_NUMBER).$${COMMIT_ID_SUFFIX}"; \ | ||
| else \ | ||
| AUTHOR=$$(jq -r '.refs[0].pulls[0].author' <<< $${CLONEREFS_OPTIONS} | tr -d '[:space:]'); \ | ||
| PULL_PULL_SHA=$${PULL_PULL_SHA:-$$(jq -r '.refs[0].pulls[0].sha' <<< $${CLONEREFS_OPTIONS} | tr -d '[:space:]')}; \ | ||
| COMMIT_ID_SUFFIX=$$(echo "$${PULL_PULL_SHA}" | cut -c1-7); \ | ||
| echo "from.$(REPO_NAME).PR$(PULL_NUMBER).$${COMMIT_ID_SUFFIX}"; \ | ||
| fi; \ | ||
| else \ | ||
| echo "latest"; \ | ||
| fi) | ||
|
Comment on lines
+13
to
+27
Contributor
There was a problem hiding this comment. If I understand this correctly the tags will be something like :
I'm wondering if we really need to add all this information to the image tag or if just the short commit sha ( 7 chars ) would be enough ? In order to simplify a bit the code and the tag names. Also I'f I'm not mistaken there is a limit in the length of the tag which is 128 chars.
Contributor
Author
There was a problem hiding this comment. @mfrancisc thanks for all your suggestions!
Yes, exactly!
I used the same approach as we use for pushing host and member images.
Contributor
There was a problem hiding this comment. makes sense! Thanks for your additional details. Let's keep it consistent with the other tags than I agree 👍 |
||
|
|
||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| IMAGE_TO_PUSH_IN_QUAY ?= quay.io/$(QUAY_NAMESPACE)/sandbox-rhdh-plugin:$(TAG) | ||
|
|
||
|
|
||
| .PHONY: deploy-sandbox-ui | ||
| deploy-sandbox-ui: REGISTRATION_SERVICE_API=https://$(shell oc get route registration-service -n ${HOST_NS} -o custom-columns=":spec.host" | tr -d '\n')/api/v1 | ||
| deploy-sandbox-ui: HOST_OPERATOR_API=https://$(shell oc get route api -n ${HOST_NS} -o custom-columns=":spec.host" | tr -d '\n') | ||
|
|
@@ -21,11 +40,11 @@ ifeq ($(PUSH_SANDBOX_IMAGE),true) | |
| $(MAKE) push-sandbox-plugin | ||
| endif | ||
| kustomize build deploy/sandbox-ui/ui-e2e-tests | REGISTRATION_SERVICE_API=${REGISTRATION_SERVICE_API} \ | ||
| HOST_NS=${HOST_NS} \ | ||
| HOST_OPERATOR_API=${HOST_OPERATOR_API} \ | ||
| SANDBOX_UI_NS=${SANDBOX_UI_NS} \ | ||
| SANDBOX_PLUGIN_IMAGE=${IMAGE_TO_PUSH_IN_QUAY} \ | ||
| RHDH=${RHDH} envsubst | oc apply -f - | ||
| $(MAKE) configure-oauth-idp | ||
| @echo "restarting registration-service to apply toolchainconfig changes" | ||
| @oc -n ${HOST_NS} rollout restart deploy/registration-service | ||
|
|
@@ -71,10 +90,43 @@ create-namespace: | |
| .PHONY: get-rhdh-plugins | ||
| get-rhdh-plugins: | ||
| ifeq ($(strip $(RHDH_PLUGINS_DIR)), $(TMPDIR)rhdh-plugins) | ||
| ifeq ($(GITHUB_ACTIONS),true) | ||
| @echo "using author ${AUTHOR}" | ||
| $(eval AUTHOR_LINK = https://github.com/${AUTHOR}) | ||
| @echo "detected branch ${BRANCH_NAME}" | ||
| # check if a branch with the same ref exists in the user's fork of rhdh-plugins repo | ||
| @echo "branches of ${AUTHOR_LINK}/rhdh-plugins - checking if there is a branch ${BRANCH_NAME} we could pair with." | ||
| curl ${AUTHOR_LINK}/rhdh-plugins.git/info/refs?service=git-upload-pack --output - | ||
| $(eval REMOTE_RHDH_PLUGINS_BRANCH := $(shell curl ${AUTHOR_LINK}/rhdh-plugins.git/info/refs?service=git-upload-pack --output - 2>/dev/null | grep -a "refs/heads/${BRANCH_NAME}$$" | awk '{print $$2}')) | ||
|
Comment on lines
+114
to
+115
There was a problem hiding this comment. Unsafe curl output redirection may expose sensitive data. Line 118 uses - curl ${AUTHOR_LINK}/rhdh-plugins.git/info/refs?service=git-upload-pack --output -
- $(eval REMOTE_RHDH_PLUGINS_BRANCH := $(shell curl ${AUTHOR_LINK}/rhdh-plugins.git/info/refs?service=git-upload-pack --output - 2>/dev/null | grep -a "refs/heads/${BRANCH_NAME}$$" | awk '{print $$2}'))
+ @echo "Checking for branch ${BRANCH_NAME} in ${AUTHOR_LINK}/rhdh-plugins..."
+ $(eval REMOTE_RHDH_PLUGINS_BRANCH := $(shell curl -s ${AUTHOR_LINK}/rhdh-plugins.git/info/refs?service=git-upload-pack 2>/dev/null | grep -a "refs/heads/${BRANCH_NAME}$$" | awk '{print $$2}'))🤖 Prompt for AI Agents |
||
|
|
||
| # check if the branch with the same name exists, if so then merge it with master and use the merge branch, if not then use master | ||
| @echo "REMOTE_RHDH_PLUGINS_BRANCH: ${REMOTE_RHDH_PLUGINS_BRANCH}" | ||
| @$(MAKE) pair-if-needed REMOTE_RHDH_PLUGINS_BRANCH=${REMOTE_RHDH_PLUGINS_BRANCH} AUTHOR_LINK=${AUTHOR_LINK} | ||
| else | ||
| @echo "using rhdh-plugins repo from master" | ||
| @$(MAKE) clone-rhdh-plugins | ||
| endif | ||
| else | ||
| @echo "using local rhdh-plugins repo, no pairing needed: ${RHDH_PLUGINS_DIR}" | ||
| endif | ||
|
|
||
|
Comment on lines
+93
to
+127
There was a problem hiding this comment. 🛠️ Refactor suggestion GA pairing depends on undefined AUTHOR/BRANCH_NAME. Default these from GA env to avoid no-op pairing. -ifeq ($(GITHUB_ACTIONS),true)
+ifeq ($(GITHUB_ACTIONS),true)
+ # defaults for GA
+ AUTHOR ?= $(GITHUB_ACTOR)
+ BRANCH_NAME ?= $(GITHUB_HEAD_REF)
@echo "using author ${AUTHOR}"
$(eval AUTHOR_LINK = https://github.com/${AUTHOR})
@echo "detected branch ${BRANCH_NAME}"
|
||
| pair-if-needed: | ||
| ifneq ($(strip $(REMOTE_RHDH_PLUGINS_BRANCH)),) | ||
| @echo "Branch ref of the user's fork to be used for pairing: \"${REMOTE_RHDH_PLUGINS_BRANCH}\"" | ||
| git config --global user.email "devsandbox@redhat.com" | ||
| git config --global user.name "KubeSaw" | ||
| # clone | ||
| rm -rf ${RHDH_PLUGINS_DIR} | ||
|
rsoaresd marked this conversation as resolved.
Outdated
|
||
| git clone --depth=1 https://github.com/redhat-developer/rhdh-plugins.git ${RHDH_PLUGINS_DIR} | ||
| # add the user's fork as remote repo | ||
| git --git-dir=${RHDH_PLUGINS_DIR}/.git --work-tree=${RHDH_PLUGINS_DIR} remote add external ${AUTHOR_LINK}/rhdh-plugins.git | ||
| # fetch the branch | ||
| git --git-dir=${RHDH_PLUGINS_DIR}/.git --work-tree=${RHDH_PLUGINS_DIR} fetch external ${REMOTE_RHDH_PLUGINS_BRANCH} | ||
| # merge the branch with master | ||
| git --git-dir=${RHDH_PLUGINS_DIR}/.git --work-tree=${RHDH_PLUGINS_DIR} merge --allow-unrelated-histories --no-commit FETCH_HEAD | ||
| else | ||
|
Comment on lines
+134
to
+142
Collaborator
There was a problem hiding this comment. this code and the other ones look very similar (if not the same) to what we have in the scripts/ci. Probably stupid question - have you considered adding a file similar to
Collaborator
There was a problem hiding this comment. never mind, I see the differences and challenges in the code
Contributor
Author
There was a problem hiding this comment. TBH, I did this way to try to simplify as much as I could |
||
| @echo "no pairing needed, using rhdh-plugins repo from master" | ||
| @$(MAKE) clone-rhdh-plugins | ||
| endif | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| .PHONY: clone-rhdh-plugins | ||
|
|
@@ -91,9 +143,9 @@ push-sandbox-plugin: | |
| rm -rf red-hat-developer-hub-backstage-plugin-sandbox && \ | ||
| yarn install && \ | ||
| npx @janus-idp/cli@3.3.1 package package-dynamic-plugins \ | ||
| --tag $(IMAGE_TO_PUSH_IN_QUAY) \ | ||
| --platform $(PLATFORM) && \ | ||
| podman push $(IMAGE_TO_PUSH_IN_QUAY) | ||
|
|
||
| .PHONY: clean-sandbox-ui | ||
| clean-sandbox-ui: | ||
|
|
@@ -141,7 +193,7 @@ build-sandbox-ui-e2e-tests: | |
| podman build --platform $(PLATFORM) -t $(UNIT_TEST_IMAGE_NAME) -f $(UNIT_TEST_DOCKERFILE) . | ||
|
|
||
| # Run Developer Sandbox UI e2e tests image using podman | ||
| .PHONY: test-sandbox-ui-in-container | ||
| test-sandbox-ui-in-container: build-sandbox-ui-e2e-tests | ||
| @echo "pushing Developer Sandbox UI image..." | ||
| $(MAKE) push-sandbox-plugin | ||
|
|
@@ -159,4 +211,4 @@ test-sandbox-ui-in-container: build-sandbox-ui-e2e-tests | |
| -e TMP=/tmp/ \ | ||
| -e PUSH_SANDBOX_IMAGE=false \ | ||
| -e RUNNING_IN_CONTAINER=true \ | ||
| $(UNIT_TEST_IMAGE_NAME) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
temporary, just to test