Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Guided onboarding] Add functional tests for a user with no access #156410

Closed
yuliacech opened this issue May 2, 2023 · 2 comments
Closed

[Guided onboarding] Add functional tests for a user with no access #156410

yuliacech opened this issue May 2, 2023 · 2 comments
Labels
Team:Journey/Onboarding Platform Journey Onboarding team

Comments

@yuliacech
Copy link
Contributor

In #155065 we added a Kibana feature to control access to guided onboarding. We need to add functional tests that check that guided onboarding is indeed disabled when a user doesn't have access. That includes:

  • /getting_started route is not available in the home plugin
  • there is no header button "Setup guides"
  • there is no help link "Setup guides"
@yuliacech yuliacech added the Team:Journey/Onboarding Platform Journey Onboarding team label May 2, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

yuliacech added a commit that referenced this issue May 3, 2023
## Summary

This PR fixes a bug introduced in
#155065 that I noticed when
testing guided onboarding for v8.9.0: the help link was missing from the
help menu. I added a functional test for the help link but we also need
a test that the link is hidden when the user doesn't have access to
guided onboarding (opened an issue for that
[here](#156410)).

### How to test
1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml
2. Start ES with yarn es snapshot and Kibana with `yarn start``
3. Check that the help link "Setup guides" is displayed in the help menu

### Screenshot 
<img width="336" alt="Screenshot 2023-05-02 at 17 27 20"
src="https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png">
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue May 3, 2023
## Summary

This PR fixes a bug introduced in
elastic#155065 that I noticed when
testing guided onboarding for v8.9.0: the help link was missing from the
help menu. I added a functional test for the help link but we also need
a test that the link is hidden when the user doesn't have access to
guided onboarding (opened an issue for that
[here](elastic#156410)).

### How to test
1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml
2. Start ES with yarn es snapshot and Kibana with `yarn start``
3. Check that the help link "Setup guides" is displayed in the help menu

### Screenshot
<img width="336" alt="Screenshot 2023-05-02 at 17 27 20"
src="https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png">

(cherry picked from commit d00e2a3)
kibanamachine referenced this issue May 3, 2023
# Backport

This will backport the following commits from `main` to `8.8`:
- [[Guided onboarding] Fix the missing help link
(#156399)](#156399)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Yulia
Čech","email":"6585477+yuliacech@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-05-03T14:00:09Z","message":"[Guided
onboarding] Fix the missing help link (#156399)\n\n##
Summary\r\n\r\nThis PR fixes a bug introduced
in\r\nhttps://github.com//pull/155065/ that I noticed
when\r\ntesting guided onboarding for v8.9.0: the help link was missing
from the\r\nhelp menu. I added a functional test for the help link but
we also need\r\na test that the link is hidden when the user doesn't
have access to\r\nguided onboarding (opened an issue for
that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n###
How to test\r\n1. Add xpack.cloud.id: 'testID' to
/config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana
with `yarn start``\r\n3. Check that the help link \"Setup guides\" is
displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\"
alt=\"Screenshot 2023-05-02 at 17 27
20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","Team:Journey/Onboarding","v8.8.0","v8.9.0"],"number":156399,"url":"https://github.com/elastic/kibana/pull/156399","mergeCommit":{"message":"[Guided
onboarding] Fix the missing help link (#156399)\n\n##
Summary\r\n\r\nThis PR fixes a bug introduced
in\r\nhttps://github.com//pull/155065/ that I noticed
when\r\ntesting guided onboarding for v8.9.0: the help link was missing
from the\r\nhelp menu. I added a functional test for the help link but
we also need\r\na test that the link is hidden when the user doesn't
have access to\r\nguided onboarding (opened an issue for
that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n###
How to test\r\n1. Add xpack.cloud.id: 'testID' to
/config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana
with `yarn start``\r\n3. Check that the help link \"Setup guides\" is
displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\"
alt=\"Screenshot 2023-05-02 at 17 27
20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156399","number":156399,"mergeCommit":{"message":"[Guided
onboarding] Fix the missing help link (#156399)\n\n##
Summary\r\n\r\nThis PR fixes a bug introduced
in\r\nhttps://github.com//pull/155065/ that I noticed
when\r\ntesting guided onboarding for v8.9.0: the help link was missing
from the\r\nhelp menu. I added a functional test for the help link but
we also need\r\na test that the link is hidden when the user doesn't
have access to\r\nguided onboarding (opened an issue for
that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n###
How to test\r\n1. Add xpack.cloud.id: 'testID' to
/config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana
with `yarn start``\r\n3. Check that the help link \"Setup guides\" is
displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\"
alt=\"Screenshot 2023-05-02 at 17 27
20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399"}}]}]
BACKPORT-->

Co-authored-by: Yulia Čech <6585477+yuliacech@users.noreply.github.com>
@alisonelizabeth
Copy link
Contributor

Future improvements to guided onboarding is not being prioritized at the moment, closing as not planned.

@alisonelizabeth alisonelizabeth closed this as not planned Won't fix, can't repro, duplicate, stale Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Journey/Onboarding Platform Journey Onboarding team
Projects
None yet
Development

No branches or pull requests

3 participants