Skip to content

[minor] Support ability to disable "WalkMe" guided tour feature#1168

Merged
durera merged 19 commits into
masterfrom
core3444
Aug 20, 2024
Merged

[minor] Support ability to disable "WalkMe" guided tour feature#1168
durera merged 19 commits into
masterfrom
core3444

Conversation

@sekharcvalluri
Copy link
Copy Markdown
Contributor

@sekharcvalluri sekharcvalluri commented Aug 9, 2024

There is a system setting for "Guided Tours" (spec->settings->walkme) in Suite CR. It is enabled by default and can be configured from the admin UI. Due to the pop of "what's new" some of the UI test cases from Manage are failing, hence, that needs to be turned off for all fvt environments by default. As a fix, an environment variable (MAS_ENABLE_WALKME) has been introduced to control the 'walkme' setting. FVT pipelines need to use this env to disable the setting.

Testing: Changes have been tested locally as well as on the pfvt (fyre-envs) env.

Bug details and snap shots of the FVT run can be found here: MASCORE-3444

Reference to ansible-devops changes: ibm-mas/ansible-devops#1409

Copy link
Copy Markdown
Contributor

@durera durera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

although the param is mas_enable_walkme I think at the CLI level we probably want the default if you do nothing with non-interactive to be walkme enabled ... so

-mas-enable-walkme MAS_ENABLE_WALKME           Enable or disable guided tour

should probably be

-disable-walkme  Disable MAS guided tour

And the param would be configured as:

masAdvancedArgGroup.add_argument(
    "--mas-enable-walkme",
    dest="mas_enable_walkme",
    required=False,
    help="Enable or disable guided tour",
    action="store_const",
    const="false"
)

Much in the same way that --disable-ca-trust param works. Other than that tweak to the command flags I think the rest is good 👍

@sekharcvalluri
Copy link
Copy Markdown
Contributor Author

although the param is mas_enable_walkme I think at the CLI level we probably want the default if you do nothing with non-interactive to be walkme enabled ... so

-mas-enable-walkme MAS_ENABLE_WALKME           Enable or disable guided tour

should probably be

-disable-walkme  Disable MAS guided tour

And the param would be configured as:

masAdvancedArgGroup.add_argument(
    "--mas-enable-walkme",
    dest="mas_enable_walkme",
    required=False,
    help="Enable or disable guided tour",
    action="store_const",
    const="false"
)

Much in the same way that --disable-ca-trust param works. Other than that tweak to the command flags I think the rest is good 👍

Incorporated the changes suggested and tested both scenarios in non-interactive mode again

@sekharcvalluri sekharcvalluri requested a review from durera August 19, 2024 07:42
@durera durera changed the title [patch] Pass a new parameter in the install pipeline to disable walkme setting [minor] Support ability to disable "WalkMe" guided tour feature Aug 20, 2024
@durera durera self-assigned this Aug 20, 2024
@durera durera added the Enhancement New feature or request label Aug 20, 2024
@durera durera merged commit a0c6d85 into master Aug 20, 2024
@durera durera deleted the core3444 branch August 20, 2024 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants