-
Notifications
You must be signed in to change notification settings - Fork 189
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
refactor(#3398): Add control flow syntax to icon bar and improved e2e tests #3399
Merged
tenthe
merged 3 commits into
dev
from
3398-migrate-iconbar-component-to-control-flow-syntax
Jan 7, 2025
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
| export class NavigationUtils { | ||
| /** | ||
| * Validates that the Pipelines navigation icon is displayed. | ||
| */ | ||
| public static pipelinesIsDisplayed() { | ||
| this.validateNavigationIcon('pipelines', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Pipelines navigation icon is not displayed. | ||
| */ | ||
| public static pipelinesNotDisplayed() { | ||
| this.validateNavigationIcon('pipelines', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Connect navigation icon is displayed. | ||
| */ | ||
| public static connectIsDisplayed() { | ||
| this.validateNavigationIcon('connect', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Connect navigation icon is not displayed. | ||
| */ | ||
| public static connectNotDisplayed() { | ||
| this.validateNavigationIcon('connect', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Dashboard navigation icon is displayed. | ||
| */ | ||
| public static dashboardIsDisplayed() { | ||
| this.validateNavigationIcon('dashboard', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Dashboard navigation icon is not displayed. | ||
| */ | ||
| public static dashboardNotDisplayed() { | ||
| this.validateNavigationIcon('dashboard', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Data Explorer navigation icon is displayed. | ||
| */ | ||
| public static dataExplorerIsDisplayed() { | ||
| this.validateNavigationIcon('dataexplorer', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Data Explorer navigation icon is not displayed. | ||
| */ | ||
| public static dataExplorerNotDisplayed() { | ||
| this.validateNavigationIcon('dataexplorer', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Asset Management navigation icon is displayed. | ||
| */ | ||
| public static assetManagementIsDisplayed() { | ||
| this.validateNavigationIcon('assets', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Asset Management navigation icon is not displayed. | ||
| */ | ||
| public static assetManagementNotDisplayed() { | ||
| this.validateNavigationIcon('assets', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Configuration navigation icon is displayed. | ||
| */ | ||
| public static configurationIsDisplayed() { | ||
| this.validateNavigationIcon('configuration', true); | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the Configuration navigation icon is not displayed. | ||
| */ | ||
| public static configurationNotDisplayed() { | ||
| this.validateNavigationIcon('configuration', false); | ||
| } | ||
|
|
||
| /** | ||
| * Validates the visibility of a navigation icon. | ||
| * @param icon The icon identifier. | ||
| * @param shown Whether the icon should be shown. | ||
| */ | ||
| private static validateNavigationIcon(icon: string, shown: boolean) { | ||
| const expectedLength = shown ? 1 : 0; | ||
| cy.dataCy(`navigation-icon-${icon}`, { timeout: 10000 }).should( | ||
| 'have.length', | ||
| expectedLength, | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Theoretically, during the test for the ROLE_ASSET, all navigation icons could be visible (including those that shouldn't be), and the test would still pass, even though a user with the Asset-role shouldn't see all the icons, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you are right. I thought of that, but then we would always need a block like this:
This is quite hard to read and understand.
I could change the API of
NavigationUtilsto take a list of strings representing all the modules that should be displayed. This way, we can validate that only the specified modules are shown. Additionally, I could add all the module names as static variables to the class to make the API easier to use.Updated API Code
Usage Example
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this looks great! I believe this approach makes it easier to verify that the user roles behave as expected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Marcelfrueh, I have changed the code accordingly. Please take a look at this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!