Merge pull request #3 from opensearch-project/feature/ci-flow

feat: add workflows

.github/workflows/backport.yml

@@ -0,0 +1,43 @@
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    name: Backport
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    steps:
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/[email protected]
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          # opensearch-trigger-bot installation ID
+          installation_id: 22958780
+
+      - name: Backport
+        uses: VachaShah/[email protected]
+        with:
+          github_token: ${{ steps.github_app_token.outputs.token }}
+          head_template: backport/backport-<%= number %>-to-<%= base %>
+          files_to_skip: "CHANGELOG.md"
+          labels_template: "<%= JSON.stringify([...labels, 'autocut']) %>"
+          failure_labels: "failed backport"

.github/workflows/changelog_verifier.yml

@@ -0,0 +1,19 @@
+name: "Changelog Verifier"
+on:
+  pull_request:
+    branches: [ '**' ]
+    types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request
+  verify-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - uses: dangoslen/changelog-enforcer@v3
+        with:
+          skipLabels: "autocut, Skip-Changelog"

.github/workflows/links_checker.yml

@@ -0,0 +1,37 @@
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+
+name: Link Checker
+
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+jobs:
+  linkchecker:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Checkout OpenSearch-Dashboards
+      uses: actions/checkout@v2
+      with:
+        repository: opensearch-project/OpenSearch-Dashboards
+        ref: main
+        path: OpenSearch-Dashboards
+    - name: Load Excludes
+      run: |
+        LYCHEE_EXCLUDE=$(sed -e :a  -e 'N;s/\n/ --exclude /;ta' OpenSearch-Dashboards/.lycheeexclude)
+        echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV
+    - name: Lychee Link Checker
+      id: lychee
+      uses: lycheeverse/[email protected]
+      with:
+        args: --accept=200,403,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail "**/*.html" "**/*.md" "**/*.txt" "**/*.json" "**/*.js" "**/*.ts" "**/*.tsx"
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    - name: Fail if there were link errors
+      run: exit ${{ steps.lychee.outputs.exit_code }}

.github/workflows/unit_test_workflow.yml

@@ -0,0 +1,98 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Build and test
+
+# trigger on every commit push and PR for all branches except pushes for backport branches
+on:
+  pull_request:
+    branches: ["**"]
+  push:
+    branches: ["**"]
+env:
+  OPENSEARCH_DASHBOARDS_VERSION: '2.x'
+  NODE_OPTIONS: "--max-old-space-size=6144 --dns-result-order=ipv4first"
+
+jobs:
+  Get-CI-Image-Tag:
+    uses: opensearch-project/opensearch-build/.github/workflows/get-ci-image-tag.yml@main
+    with:
+      product: opensearch-dashboards
+
+  tests-linux:
+    needs: Get-CI-Image-Tag
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    container:
+      # using the same image which is used by opensearch-build team to build the OpenSearch Distribution
+      # this image tag is subject to change as more dependencies and updates will arrive over time
+      image: ${{ needs.Get-CI-Image-Tag.outputs.ci-image-version-linux }}
+      # need to switch to root so that github actions can install runner binary on container without permission issues.
+      options: --user root
+
+    steps:
+      # Enable longer filenames for windows
+      - name: Checkout OpenSearch-Dashboards
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          path: OpenSearch-Dashboards
+      - name: Checkout dashboards-assistant plugin
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/dashboards-assistant
+      - name: Bootstrap / Run tests
+        run: |
+          chown -R 1000:1000 `pwd`
+          cd ./OpenSearch-Dashboards/
+          su `id -un 1000` -c "source $NVM_DIR/nvm.sh && nvm use && node -v && yarn -v &&
+                               cd ./plugins/dashboards-assistant &&
+                               whoami && yarn osd bootstrap && yarn run test:jest --coverage"
+
+      - name: Uploads coverage
+        uses: codecov/codecov-action@v1
+
+  tests-windows-macos:
+    name: Run unit tests
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      # Enable longer filenames for windows
+      - name: Enable longer filenames
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: git config --system core.longpaths true
+      - name: Checkout OpenSearch-Dashboards
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          path: OpenSearch-Dashboards
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: './OpenSearch-Dashboards/.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install Yarn
+        # Need to use bash to avoid having a windows/linux specific step
+        shell: bash
+        run: |
+          YARN_VERSION=$(node -p "require('./OpenSearch-Dashboards/package.json').engines.yarn")
+          echo "Installing yarn@$YARN_VERSION"
+          npm i -g yarn@$YARN_VERSION
+      - run: node -v
+      - run: yarn -v
+      - name: Checkout dashboards-assistant plugin
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/dashboards-assistant
+      - name: Bootstrap plugin/dashboards-assistant
+        run: |
+          cd OpenSearch-Dashboards/plugins/dashboards-assistant
+          yarn osd bootstrap
+      - name: Run tests
+        run: |
+          cd OpenSearch-Dashboards/plugins/dashboards-assistant
+          yarn run test:jest --coverage

babel.config.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// babelrc doesn't respect NODE_PATH anymore but using require does.
+// Alternative to install them locally in node_modules
+module.exports = function (api) {
+  // ensure env is test so that this config won't impact build or dev server
+  if (api.env('test')) {
+    return {
+      presets: [
+        require('@babel/preset-env'),
+        require('@babel/preset-react'),
+        require('@babel/preset-typescript'),
+      ],
+      plugins: [
+        [require('@babel/plugin-transform-runtime'), { regenerator: true }],
+        require('@babel/plugin-proposal-class-properties'),
+        require('@babel/plugin-proposal-object-rest-spread'),
+        [require('@babel/plugin-transform-modules-commonjs'), { allowTopLevelThis: true }],
+      ],
+    };
+  }
+  return {};
+};

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "osd": "node ../../scripts/osd",
     "build": "yarn plugin-helpers build",
-    "test": "../../node_modules/.bin/jest --config ./test/jest.config.js",
+    "test:jest": "../../node_modules/.bin/jest --config ./test/jest.config.js",
     "plugin-helpers": "node ../../scripts/plugin_helpers",
     "prepare": "husky install",
     "lint:es": "node ../../scripts/eslint",

test/jest.config.js

@@ -22,11 +22,8 @@ module.exports = {
     '<rootDir>/public/requests/',
     '/__utils__/',
   ],
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', { diagnostics: false }],
-    'node_modules/(langchain|langsmith)/.+\\.js$': ['ts-jest', { diagnostics: false }],
-  },
-  transformIgnorePatterns: ['<rootDir>/node_modules/(?!langchain|langsmith)'],
+  // https://github.com/jestjs/jest/issues/6229#issuecomment-403539460
+  transformIgnorePatterns: ['node_modules/(?!langchain|langsmith)'],
   moduleNameMapper: {
     '\\.(css|less|sass|scss)$': '<rootDir>/test/__mocks__/styleMock.js',
     '\\.(gif|ttf|eot|svg|png)$': '<rootDir>/test/__mocks__/fileMock.js',