[2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 #1533

RyanL1997 · 2023-08-01T23:15:26Z

Description

Change the regex command in install dashboard GHA to handle generic format of version numbers. This PR also includes the version bump to 2.10.0.

Issues Resolved

Relate [AUTO] Increment version to 2.10.0.0 #1526
Resolve [BUG] install_dashboards github action is not properly handling multi-digit major or minor versions #1532

Testing

Before:

After:

Check List

New functionality includes testing
New functionality has been documented
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

codecov · 2023-08-01T23:27:20Z

Codecov Report

Merging #1533 (71fe260) into 2.x (d8f5851) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              2.x    #1533   +/-   ##
=======================================
  Coverage   66.06%   66.06%           
=======================================
  Files          93       93           
  Lines        2328     2328           
  Branches      310      310           
=======================================
  Hits         1538     1538           
  Misses        722      722           
  Partials       68       68

RyanL1997 · 2023-08-01T23:32:20Z

.github/actions/install-dashboards/action.yml

@@ -39,8 +39,8 @@ runs:

    - id: osd-version
      run: |
-        echo "::set-output name=osd-version::$(cat package.json | jq '.opensearchDashboards.version' | cut -c 2-4)"
-        echo "::set-output name=osd-x-version::$(cat package.json | jq '.opensearchDashboards.version' | cut -c 2-3)"
+        echo "::set-output name=osd-version::$(jq -r '.opensearchDashboards.version' package.json)"


Here is a little break down of the first command:

-r (or --raw-output): This option tells jq to output raw strings instead of JSON-encoded strings, which means it won't wrap the output in quotes.

If .opensearchDashboards.version is 2.10.0 will this produce the following?

osd-version = 2.10 osd-x-version = 2.

I believe that's what the current logic intends.

Yeah, for the x-version, I moved the .x into this step. so it will be "2.x" directly.

jq -r '.opensearchDashboards.version' package.json will output 2.10.0 right? This variable is used to checkout a branch here so it should match the branch name 2.10.

@cwperks nice catch! My bad, I wasnt noticing that at the beginning. I just fixed with:

echo "::set-output name=osd-version::$(jq -r '.opensearchDashboards.version | split(".") | .[:2] | join(".")' package.json)"

This will be the same strategy as the [0] we used down below. But [0] is just getting the first element, and this line will get the first 2 element of the array by using [:2]. So it will be 2 and 10 from ["2", "10", "0"] and join with . in between.

RyanL1997 · 2023-08-02T00:08:36Z

.github/actions/install-dashboards/action.yml

-        echo "::set-output name=osd-version::$(cat package.json | jq '.opensearchDashboards.version' | cut -c 2-4)"
-        echo "::set-output name=osd-x-version::$(cat package.json | jq '.opensearchDashboards.version' | cut -c 2-3)"
+        echo "::set-output name=osd-version::$(jq -r '.opensearchDashboards.version' package.json)"
+        echo "::set-output name=osd-x-version::$(jq -r '.opensearchDashboards.version | split(".") | .[0]' package.json).x"


Here's what's happening in the second command:

split("."): This is another jq filter that splits the version string into an array of strings using the period as a delimiter. This would turn "2.10.0" into ["2", "10", "0"].

.[0]: This is a jq filter that selects the first element of the array. This would extract the "2" from ["2", "10", "0"].

.x: This is concatenated onto the end of the major version number. So if the major version number is "2", it becomes "2.x". (This was originally at the next step of branch switching and I moved to here to make the entire flow more straight forward.)

cwperks · 2023-08-02T00:30:40Z

.github/actions/install-dashboards/action.yml

      working-directory: ${{ steps.determine-plugin-directory.outputs.plugin-directory }}
      shell: bash

    - id: branch-switch-if-possible
      continue-on-error: true # Defaults onto main if the branch switch doesn't work
      if: ${{ steps.osd-version.outputs.osd-version }}
-      run: git checkout ${{ steps.osd-version.outputs.osd-version }} || git checkout ${{ steps.osd-version.outputs.osd-x-version }}x
+      run: git checkout ${{ steps.osd-version.outputs.osd-version }} || git checkout ${{ steps.osd-version.outputs.osd-x-version }}


Oh I see you removed the x here. Nice! I like this change.

Yes, I have moved the .x up there when we parsing those versions. So this one should only be just trying out to see if we have a specific version branch, such as 2.10. If it is not, it will just grab the x line as version.

RyanL1997 · 2023-08-02T01:51:58Z

Looking into this:

FAIL test/jest_integration/saml_auth.test.ts (35.497 s)
  start OpenSearch Dashboards server
    ✓ Login to app/opensearch_dashboards_overview#/ when SAML is enabled (21476 ms)
    ✕ Login to app/dev_tools#/console when SAML is enabled (114 ms)
    ✕ Login to Dashboard with Hash (109 ms)
    ○ skipped Tenancy persisted after Logout in SAML

  ● start OpenSearch Dashboards server › Login to app/dev_tools#/console when SAML is enabled

I don't think this is related to this change btw.

Reference:
https://github.com/opensearch-project/security-dashboards-plugin/actions/runs/5733034965/job/15537963336?pr=1533#step:14:486

RyanL1997 · 2023-08-02T02:36:42Z

The current CI failure is introduced by the backport of this breaking change in core: opensearch-project/OpenSearch#9006

cwperks · 2023-08-02T02:39:01Z

Thank you @RyanL1997! This change (minus the version increment) should be done against main as well.

cwperks · 2023-08-03T00:48:36Z

I'm seeing a lot of InvalidArgumentError: binary is not a Firefox executable in the build output.

I see a successful run here with FF 115.

Mozilla Firefox 115.0.2
Successfully setup firefox version 115.0.2

This branch is failing with FF 116

Mozilla Firefox 116.0
Successfully setup firefox version 116.0

…rmat Signed-off-by: Ryan Liang <jiallian@amazon.com>

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 commented Aug 1, 2023

View reviewed changes

RyanL1997 mentioned this pull request Aug 1, 2023

[AUTO] Increment version to 2.10.0.0 #1526

Closed

RyanL1997 changed the title ~~[Bug fix] Change the regex command in install dashboard GHA~~ [2.x] Change the regex command in install dashboard GHA Aug 1, 2023

RyanL1997 commented Aug 2, 2023

View reviewed changes

RyanL1997 self-assigned this Aug 2, 2023

RyanL1997 changed the title ~~[2.x] Change the regex command in install dashboard GHA~~ [2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 Aug 2, 2023

cwperks reviewed Aug 2, 2023

View reviewed changes

cwperks approved these changes Aug 2, 2023

View reviewed changes

RyanL1997 mentioned this pull request Aug 2, 2023

Change the version parsing command's regex to handle double digits minor versions #1537

Merged

3 tasks

RyanL1997 force-pushed the gha-regx-fix-2.x branch from 11dc1f4 to 1203e9a Compare August 2, 2023 21:53

cwperks mentioned this pull request Aug 3, 2023

[AUTO] Increment version to 2.10.0.0 #1534

Closed

cwperks added the v2.10.0 label Aug 3, 2023

This was referenced Aug 3, 2023

Security Getting Started page follows Dashboard themes #1538

Merged

[BUG] Issues running selenium tests with headless Firefox #1540

Closed

RyanL1997 added 4 commits August 3, 2023 11:41

Change to regex in install dashboard gha to handle generic version fo…

255f999

…rmat Signed-off-by: Ryan Liang <jiallian@amazon.com>

Add the version increment to 2.10.0

6c0bcc9

Signed-off-by: Ryan Liang <jiallian@amazon.com>

Handle the case when switching to x line

d7f4dcc

Signed-off-by: Ryan Liang <jiallian@amazon.com>

Correct the git checkout format

71fe260

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 force-pushed the gha-regx-fix-2.x branch from 1203e9a to 71fe260 Compare August 3, 2023 18:43

RyanL1997 merged commit a5e35e3 into opensearch-project:2.x Aug 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 #1533

[2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 #1533

RyanL1997 commented Aug 1, 2023 •

edited

Loading

codecov bot commented Aug 1, 2023 •

edited

Loading

RyanL1997 Aug 1, 2023 •

edited

Loading

cwperks Aug 2, 2023 •

edited

Loading

RyanL1997 Aug 2, 2023

cwperks Aug 2, 2023 •

edited

Loading

RyanL1997 Aug 2, 2023 •

edited

Loading

RyanL1997 Aug 2, 2023

cwperks Aug 2, 2023

RyanL1997 Aug 2, 2023

RyanL1997 commented Aug 2, 2023

RyanL1997 commented Aug 2, 2023

cwperks commented Aug 2, 2023

cwperks commented Aug 3, 2023 •

edited

Loading

[2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 #1533

[2.x] Change the regex command in install dashboard GHA + Increment version to 2.10.0 #1533

Conversation

RyanL1997 commented Aug 1, 2023 • edited Loading

Description

Category

Issues Resolved

Testing

Check List

codecov bot commented Aug 1, 2023 • edited Loading

Codecov Report

RyanL1997 Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

cwperks Aug 2, 2023 • edited Loading

Choose a reason for hiding this comment

RyanL1997 Aug 2, 2023

Choose a reason for hiding this comment

cwperks Aug 2, 2023 • edited Loading

Choose a reason for hiding this comment

RyanL1997 Aug 2, 2023 • edited Loading

Choose a reason for hiding this comment

RyanL1997 Aug 2, 2023

Choose a reason for hiding this comment

cwperks Aug 2, 2023

Choose a reason for hiding this comment

RyanL1997 Aug 2, 2023

Choose a reason for hiding this comment

RyanL1997 commented Aug 2, 2023

RyanL1997 commented Aug 2, 2023

cwperks commented Aug 2, 2023

cwperks commented Aug 3, 2023 • edited Loading

RyanL1997 commented Aug 1, 2023 •

edited

Loading

codecov bot commented Aug 1, 2023 •

edited

Loading

RyanL1997 Aug 1, 2023 •

edited

Loading

cwperks Aug 2, 2023 •

edited

Loading

cwperks Aug 2, 2023 •

edited

Loading

RyanL1997 Aug 2, 2023 •

edited

Loading

cwperks commented Aug 3, 2023 •

edited

Loading