Adds Storybook topic deploys to Bacon

.bacon.yml

@@ -1,14 +1,10 @@
 test_suites:
-  - name: "build"
+  - name: "Build"
     abort_commit_on_failure: true
     criteria: MERGE
-    prereq_test_suite_names:
-      - "lint"
-      - "test"
-      - "typecheck"
-    queue_name: al2023
+    queue_name: ci-queue-productionJenga-AL2023
     script_path: /root/okta/odyssey/scripts
-    sort_order: "1"
+    sort_order: "4"
     steps:
       - event: SOURCE
         action: setup.sh
@@ -18,43 +14,30 @@ test_suites:
         name: Build Packages
     timeout: "20"
 
-  - name: publish
-    abort_commit_on_failure: true
-    script_path: /root/okta/odyssey/scripts
-    sort_order: "2"
-    timeout: "15"
-    script_name: publish
-    criteria: MERGE
-    prereq_test_suite_names:
-      - "build"
-    queue_name: al2023
-
-  - name: "code coverage"
+  - name: "Code Coverage"
     abort_commit_on_failure: true
     criteria: OPTIONAL
-    # Playwright only works with certain distros of Linux
-    queue_name: ci-queue-prodJenga-Ubuntu20
-    script_path: /root/okta/odyssey/scripts
+    queue_name: ci-queue-prodJenga-Ubuntu20 # Playwright only works with certain distros of Linux
     script_name: code-coverage
-    sort_order: "5"
+    script_path: /root/okta/odyssey/scripts
+    sort_order: "6"
     timeout: "20"
 
-  - name: "interaction test"
+  - name: "Interaction Test"
     abort_commit_on_failure: true
     criteria: MERGE
-    # Playwright only works with certain distros of Linux
-    queue_name: ci-queue-prodJenga-Ubuntu20
+    queue_name: ci-queue-prodJenga-Ubuntu20 # Playwright only works with certain distros of Linux
     script_path: /root/okta/odyssey/scripts
     script_name: interaction-test
-    sort_order: "6"
+    sort_order: "5"
     timeout: "20"
 
-  - name: "lint"
+  - name: "Lint"
     abort_commit_on_failure: true
     criteria: MERGE
-    queue_name: al2023
+    queue_name: ci-queue-productionJenga-AL2023
     script_path: /root/okta/odyssey/scripts
-    sort_order: "3"
+    sort_order: "1"
     steps:
       - event: SOURCE
         action: setup.sh
@@ -64,21 +47,47 @@ test_suites:
         name: Lint Code
     timeout: "20"
 
-  - name: "test"
+  - name: "Publish Package"
     abort_commit_on_failure: true
+    criteria: MERGE
+    queue_name: ci-queue-productionJenga-AL2023
+    script_name: publish-packages
     script_path: /root/okta/odyssey/scripts
-    sort_order: "4"
-    script_name: unit-test
+    sort_order: "8"
+    timeout: "15"
+
+  - name: "Publish Storybook"
+    abort_commit_on_failure: true
     criteria: MERGE
-    queue_name: al2023
-    timeout: "20"
+    queue_name: ci-queue-productionJenga-AL2023
+    script_name: publish-storybook
+    script_path: /root/okta/odyssey/scripts
+    sort_order: "9"
+    timeout: "15"
 
-  - name: "typecheck"
+  - name: "Semgrep"
+    criteria: MERGE
+    queue_name: ci-queue-productionJenga-AL2023
+    script_name: semgrep
+    script_path: /root/okta/odyssey/scripts
+    sort_order: "7"
+    timeout: "10"
+
+  - name: "Test"
     abort_commit_on_failure: true
     criteria: MERGE
-    queue_name: al2023
+    queue_name: ci-queue-productionJenga-AL2023
+    script_name: unit-test
     script_path: /root/okta/odyssey/scripts
     sort_order: "3"
+    timeout: "20"
+
+  - name: "Typecheck"
+    abort_commit_on_failure: true
+    criteria: MERGE
+    queue_name: ci-queue-productionJenga-AL2023
+    script_path: /root/okta/odyssey/scripts
+    sort_order: "2"
     steps:
       - event: SOURCE
         action: setup.sh
@@ -88,10 +97,11 @@ test_suites:
         name: Typecheck Code
     timeout: "20"
 
-  - name: semgrep
-    criteria: MERGE
-    queue_name: al2023
-    script_name: semgrep
+  - name: "Visual Regression Test"
+    abort_commit_on_failure: true
+    criteria: OPTIONAL
+    queue_name: ci-queue-productionJenga-AL2023
+    script_name: visual-regression-test
     script_path: /root/okta/odyssey/scripts
     sort_order: "7"
-    timeout: "10"
+    timeout: "20"

package.json

@@ -107,6 +107,5 @@
     "ws@npm:8.13.0": "^8.17.1",
     "ws@npm:8.16.0": "^8.17.1"
   },
-  "version": "0.6.0",
   "packageManager": "[email protected]"
 }

packages/odyssey-storybook/applitools.config.js

@@ -30,7 +30,13 @@ module.exports = {
   exitcode: true,
   matchLevel: "Strict",
   parentBranchName,
+  puppeteerOptions: {
+    args: ["--no-sandbox", "--disable-setuid-sandbox"],
+    dumpio: true,
+    headless: true,
+  },
   serverUrl: "https://oktaeyes.applitools.com",
+  showLogs: true,
   showStorybookOutput: true,
-  testConcurrency: 10,
+  testConcurrency: 5,
 };

packages/odyssey-storybook/package.json

@@ -23,7 +23,7 @@
     "@storybook/theming": "^7.2.0"
   },
   "devDependencies": {
-    "@applitools/eyes-storybook": "^3.47.0",
+    "@applitools/eyes-storybook": "^3.50.6",
     "@babel/core": "^7.23.9",
     "@okta/odyssey-babel-loader": "workspace:*",
     "@okta/odyssey-lifecycle": "workspace:*",
@@ -69,11 +69,12 @@
   },
   "scripts": {
     "build": "storybook build --output-dir dist",
+    "ci:coverage": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn test-storybook --coverage --browsers chromium --ci\"",
+    "ci:interactionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn test-storybook --browsers chromium --ci\"",
+    "ci:visualRegressionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,VISUAL-REGRESSION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn eyes-storybook --conf ./applitools.config.js -u http://127.0.0.1:6006\"",
     "dev:coverage": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn test-storybook --url http://127.0.0.1:6006\" --coverage",
     "dev:interactionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 &&  yarn test-storybook --url http://127.0.0.1:6006\"",
-    "ci:coverage": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn test-storybook --coverage --browsers chromium --ci\"",
-    "ci:interactionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,INTERACTION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 &&  yarn test-storybook --browsers chromium --ci\"",
-    "dev:visualRegressionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,VISUAL-REGRESSION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 &&  yarn eyes-storybook --conf ./applitools.config.js -u http://127.0.0.1:6006\"",
+    "dev:visualRegressionTest": "yarn build && yarn concurrently --kill-others --success first --names \"STORYBOOK-SERVER,VISUAL-REGRESSION-TEST\" --prefix-colors \"magenta,green\" \"http-server dist --port 6006 --silent\" \"wait-on tcp:127.0.0.1:6006 && yarn eyes-storybook --conf ./applitools.config.js -u http://127.0.0.1:6006\"",
     "prepack": "yarn build && yarn exec prepack",
     "start:storybook": "storybook dev -p 6006",
     "start:types": "tsc --build --watch",

scripts/interaction-test.sh

@@ -28,4 +28,4 @@ fi
 
 # Tests were successful if it reached here
 echo "Playwright tests passed!"
-report_results SUCCESS publish_type_and_result_dir_but_succeed_if_no_results
+report_results SUCCESS publish_type_and_result_dir_but_succeed_if_no_results

scripts/publish.sh → scripts/publish-packages.sh

@@ -21,6 +21,8 @@ function lerna_publish() {
 # prevent local changes from being reported so lerna can publish
 git checkout .
 
+# All packages are built by `prepack`.
+
 # update version with commit SHA to allow lerna to publish
 FILES_TO_UPDATE_VERSION="lerna.json packages/odyssey-design-tokens/package.json packages/odyssey-babel-preset/package.json packages/odyssey-babel-loader/package.json packages/odyssey-react-mui/package.json packages/browserslist-config-odyssey/package.json"
 for PATH_AND_FILE in $FILES_TO_UPDATE_VERSION; do

scripts/publish-storybook-temp.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+
+source $OKTA_HOME/$REPO/scripts/setup.sh
+
+cd $OKTA_HOME/$REPO
+
+PUBLISH_SHA="$(git rev-parse --short $SHA)"
+PUBLISH_REGISTRY="${ARTIFACTORY_URL}/api/npm/npm-topic"
+CURRENT_VERSION=$(< lerna.json jq -r '.version')
+TAGGED_VERSION=$CURRENT_VERSION-$PUBLISH_SHA
+
+npm config set @okta:registry ${PUBLISH_REGISTRY}
+
+function lerna_publish() {
+  # use lerna to publish without making a commit to the repo
+  MY_CMD="yarn run lerna publish from-package --force-publish=* --ignore-changes --no-push --no-git-tag-version --no-verify-access --registry \"${PUBLISH_REGISTRY}\" --yes"
+  echo "Running ${MY_CMD}"
+  ${MY_CMD}
+}
+
+# prevent local changes from being reported so lerna can publish
+git checkout .
+
+# All packages are built by `prepack`.
+
+# update version with commit SHA to allow lerna to publish
+FILES_TO_UPDATE_VERSION="packages/odyssey-storybook/package.json"
+for PATH_AND_FILE in $FILES_TO_UPDATE_VERSION; do
+  FULL_PATH="$OKTA_HOME/$REPO/$PATH_AND_FILE"
+  json_contents="$(jq '.version = "'$TAGGED_VERSION'"' $FULL_PATH)" && \
+  echo -E "${json_contents}" > $FULL_PATH
+  git update-index --assume-unchanged $FULL_PATH
+done
+
+echo "Publishing to artifactory"
+if ! lerna_publish; then
+  echo "ERROR: Lerna Publish has failed."
+  exit $PUBLISH_ARTIFACTORY_FAILURE
+else
+  echo "Publish successful. Sending promotion message"
+fi
+
+##
+## Publish docs
+##
+## While the package artifact is already in npm-release, we use this
+## promotion event workaround to trigger the conductor workflow to deploy
+##
+
+echo "Publish successful. Sending promotion message"
+
+function send_promotion_message() {
+  curl -H "x-aurm-token: ${AURM_TOKEN}" \
+    -H "Content-Type: application/json" \
+    -X POST -d "[{\"artifactId\":\"$1\",\"repository\":\"npm-topic\",\"artifact\":\"$2\",\"version\":\"$3\",\"promotionType\":\"ARTIFACT\"}]" \
+    -k "${APERTURE_BASE_URL}/v1/artifact-promotion/createPromotionEvent"
+}
+
+ARTIFACT="@okta/odyssey-storybook/-/@okta/odyssey-storybook-${CURRENT_VERSION}.tgz"
+echo "Artifact is ${ARTIFACT}"
+if ! send_promotion_message "odyssey-storybook" "${ARTIFACT}" "${CURRENT_VERSION}"; then
+  echo "Error sending docs promotion event to Aperture"
+fi
+
+exit $SUCCESS

scripts/publish-storybook.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+source $OKTA_HOME/$REPO/scripts/setup.sh
+
+cd $OKTA_HOME/$REPO
+
+get_terminus_secret "/" AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID
+get_terminus_secret "/" AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY
+get_terminus_secret "/" AWS_REGION AWS_REGION
+
+export URL_STORYBOOK="https://${SHA}.ods.dev"
+echo $URL_STORYBOOK
+
+# Build all packages except Storybook because it's excluded.
+yarn build
+
+# Build Storybook package.
+cd ./packages/odyssey-storybook && rm -rf ./node_modules/.cache && yarn build
+
+aws s3 sync ./dist/ s3://ods.dev/$SHA --delete
+
+# bash ./scripts/notify-slack.sh
+
+echo "Publish successful."
+log_custom_message "Storybook URL" $URL_STORYBOOK
+
+exit $SUCCESS

scripts/setup.sh

@@ -20,7 +20,7 @@ else
 fi
 
 echo "installing yarn v${YARN_VERSION}"
-if setup_service yarn ${YARN_VERSION}; then
+if setup_service yarn-berry ${YARN_VERSION}; then
   echo "Installed yarn ${YARN_VERSION} successfully"
 else
   echo "Yarn ${YARN_VERSION} installation failed."

scripts/visual-regression-test.sh

@@ -0,0 +1,43 @@
+#!/bin/bash -x
+
+source $OKTA_HOME/$REPO/scripts/setup.sh
+
+cd $OKTA_HOME/$REPO
+
+export TEST_SUITE_TYPE="junit"
+export TEST_RESULT_FILE_DIR="${REPO}/src/v3/build2/reports/unit"
+echo $TEST_SUITE_TYPE > $TEST_SUITE_TYPE_FILE
+echo $TEST_RESULT_FILE_DIR > $TEST_RESULT_FILE_DIR_FILE
+
+get_terminus_secret "/" APPLITOOLS_API_KEY APPLITOOLS_API_KEY
+get_terminus_secret "/" APPLITOOLS_SERVER_URL APPLITOOLS_SERVER_URL
+
+if [[ -z "$APPLITOOLS_API_KEY" ]]; then
+  echo "Error in getting APPLITOOLS_API_KEY from Terminous."
+  report_results FAILURE PUBLISH_TYPE_AND_RESULT_DIR_BUT_SUCCEED_IF_NO_RESULTS
+  exit 1
+fi
+
+export APPLITOOLS_SHOW_LOGS=true
+export CHROME_VERSION="126.0.6478.55"
+
+if ! setup_service google-chrome-stable ${CHROME_VERSION}-1 ; then
+  echo "failure" > ${setup_chrome_status_file}
+fi
+
+if ! wget https://artifacts.aue1e.internal/artifactory/thirdparty-yum/x86_64/chrome-sel3/${CHROME_VERSION}-1/webdriver/${CHROME_VERSION}/chromedriver-linux64.zip ; then
+  echo "failure" > ${setup_chrome_status_file}
+fi
+
+unzip chromedriver_linux64.zip
+mv chromedriver_linux64 /usr/local/bin/
+chmod +x /usr/local/bin/chromedriver_linux64
+rm chromedriver_linux64.zip
+
+if ! yarn workspace @okta/odyssey-storybook ci:visualRegressionTest; then
+  echo "Applitools Visual Regression Tests failed! Exiting..."
+  exit ${PUBLISH_TYPE_AND_RESULT_DIR_BUT_ALWAYS_FAIL}
+fi
+
+echo "Visual Regression Tests passed!"
+report_results SUCCESS publish_type_and_result_dir_but_succeed_if_no_results