You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/05/13 16:15:33 UTC
[GitHub] [trafficcontrol] dpham692 opened a new pull request #5845: Migrate cache group test from E2E to integration test
dpham692 opened a new pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
- [x] This PR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this
Pull Request. Also, feel free to add the name of a tool or script that is
affected but not on the list.
Additionally, if this Pull Request does NOT affect documentation, please
explain why documentation is not required. -->
- CDN in a Box
- Traffic Portal
- CI tests
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your Pull Request. If
it includes tests (and most should), outline here the steps needed to run the
tests. If not, lay out the manual testing procedure and please explain why
tests are unnecessary for this Pull Request. -->
In traffic_portal/test/integration directory run command below and make sure all test pass.
`npm test -- --params.baseUrl https://localhost --capabilities.shardTestFiles true`
Make sure the new cache group test in Data file is good and reasonable.
## If this is a bug fix, what versions of Traffic Control are affected?
<!-- If this PR fixes a bug, please list here all of the affected versions - to
the best of your knowledge. It's also pretty helpful to include a commit hash
of where 'master' is at the time this PR is opened (if it affects master),
because what 'master' means will change over time. For example, if this PR
fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
look like:
- master (1df853c8)
- 4.0.0
- 4.0.1 (RC1)
If you don't know what other versions might have this bug, AND don't know how
to find the commit hash of 'master', then feel free to leave this section
blank (or, preferably, delete it entirely).
-->
## The following criteria are ALL met by this PR
<!-- Check the boxes to signify that the associated statement is true. To
"check a box", replace the space inside of the square brackets with an 'x'.
e.g.
- [ x] <- Wrong
- [x ] <- Wrong
- [] <- Wrong
- [*] <- Wrong
- [x] <- Correct!
-->
- [x] This PR includes tests OR I have explained why tests are unnecessary
- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
- [ ] This PR includes any and all required license headers
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
## Additional Information
<!-- If you would like to include any additional information on the PR for
potential reviewers please put it here.
Some examples of this would be:
- Before and after screenshots/gifs of the Traffic Portal if it is affected
- Links to other dependent Pull Requests
- References to relevant context (e.g. new/updates to dependent libraries,
mailing list records, blueprints)
Feel free to leave this section blank (or, preferably, delete it entirely).
-->
<!--
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.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #5845: Migrate cache group test from E2E to integration test
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845#discussion_r631946121
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -117,16 +116,15 @@ export class CacheGroupPage extends BasePage {
if (cachegroup.Type == "EDGE_LOC") {
const name = cachegroup.FailoverCG + this.randomize;
await this.txtFailoverCG.click();
- if(await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)))){
- await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)).click();
- }else{
+ if (await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)))) {
+ await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)).click();
+ } else {
result = undefined;
}
}
await this.txtType.sendKeys(cachegroup.Type);
await snp.ClickUpdate();
- if(result != undefined)
- {
+ if (result != undefined) {
Review comment:
comparison should use `===`/`!==`
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -117,16 +116,15 @@ export class CacheGroupPage extends BasePage {
if (cachegroup.Type == "EDGE_LOC") {
const name = cachegroup.FailoverCG + this.randomize;
await this.txtFailoverCG.click();
- if(await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)))){
- await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)).click();
- }else{
+ if (await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)))) {
Review comment:
nit/protip: since you're already using a template string, you can just interpolate `name` instead of concatenating:
```typescript
`//select[@name="fallbackOptions"]//option[@label="${name}"]`
```
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,31 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ let linkName = name;
+ let result = false;
+ if (await browser.isElementPresent(element(by.xpath("//span[text()='" + linkName + "']"))) == true) {
Review comment:
You can get links by their text using `by.linkText` or `by.partialLinkText`. However, despite the name of that variable, it looks like it's not actually a link? If this is actually just a `SPAN` element with a text node child containing the name, you could do `by.cssContainingText("span", linkName)` to get elements matching the CSS selector `span` with a text node containing `linkName`.
I just find XPath selectors harder to read than css or element selectors.
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,31 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ let linkName = name;
+ let result = false;
+ if (await browser.isElementPresent(element(by.xpath("//span[text()='" + linkName + "']"))) == true) {
+ result = true;
+ }
+ return result;
+ }
Review comment:
It looks like `linkName` is only used as an alias of the `name` argument, which is unnecessary because strings are immutable (and that assignment would be a shallow copy of an implicit reference even if they weren't - and also the value is only read, not manipulated). Likewise, `result` is only used to contain the result of a single operation that is immediately returned. Finally, `browser.isElementPresent` returns a `Promise<boolean>` (although the API weakly types its return value to `webdriver.promise.Promise<any>` for some reason).
With all this in mind, I think this method can actually just be a single line:
```typescript
public async CheckCSV(name: string): Promise<boolean> {
return browser.isElementPresent(element(by.cssContainingText("span", name)));
}
```
Or, for just a little more type-safety, you actually don't need to use `browser` at all, [since an element can check for its own presence](https://www.protractortest.org/#/api?view=ElementFinder.prototype.isPresent):
```typescript
public async CheckCSV(name: string): Promise<boolean> {
return element(by.cssContainingText("span", name)).isPresent();
}
```
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -117,16 +116,15 @@ export class CacheGroupPage extends BasePage {
if (cachegroup.Type == "EDGE_LOC") {
const name = cachegroup.FailoverCG + this.randomize;
await this.txtFailoverCG.click();
- if(await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)))){
- await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)).click();
- }else{
+ if (await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)))) {
Review comment:
Also, I wouldn't ask you to change it in this PR, but I think most people are more familiar with CSS selectors than XPath, so this could be written as:
```typescript
by.css(`select[name="fallbackOptions"] > option[label="${name}"]`)
```
##########
File path: traffic_portal/test/integration/specs/CacheGroup.spec.ts
##########
@@ -41,20 +41,38 @@ cachegroups.tests.forEach(cacheGroupData => {
await cacheGroupPage.OpenTopologyMenu();
await cacheGroupPage.OpenCacheGroupsPage();
})
+ cacheGroupData.check.forEach(check => {
+ it(check.description, async () => {
+ expect(await cacheGroupPage.CheckCSV(check.Name)).toBeTruthy();
Review comment:
`CheckCSV` returns a `Promise<boolean>`, so this can check specifically for `.toBeTrue()`, not merely `.toBeTruthy()`. Or you could use `.toBe(true)`, the difference between that and `.toBeTrue()` is convoluted and involves using `Boolean` as an ES6 constructor - which you should never do anyway.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #5845: Migrate cache group test from E2E to integration test
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845#discussion_r637004515
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,26 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ return element(by.cssContainingText("span", name)).isPresent();
+ }
+ public async ToggleTableColumn(name: string): Promise<boolean> {
+ let result = false;
+ await this.btnTableColumn.click();
+ //if it's already on, turn it off and return false
+ if (await browser.isElementPresent(element(by.xpath("//th[text()='" + name + "']"))) === true){
Review comment:
You don't need to compare a `boolean` to `true`, you can just use it as the condition. Technically, `browser.isElementPresent` returns a `Promise<any>`, but that's confusing because it's actually just an alias for `element(locator).isPresent` which returns a `Promise<boolean>`. So really this line could just be:
```typescript
if (await element(by.cssContainingText("th", name)).isPresent()) {
```
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,26 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ return element(by.cssContainingText("span", name)).isPresent();
+ }
+ public async ToggleTableColumn(name: string): Promise<boolean> {
+ let result = false;
+ await this.btnTableColumn.click();
+ //if it's already on, turn it off and return false
+ if (await browser.isElementPresent(element(by.xpath("//th[text()='" + name + "']"))) === true){
+ await element(by.xpath("//label[text()=' " + name + "']")).click();
+ result = false;
+ }else{
+ //of it already off, turn it on return true
+ await element(by.xpath("//label[text()=' " + name + "']")).click();
Review comment:
It seems like you do this click on the same element regardless of the `if` condition, could it be moved out of the `if`/`else` entirely? If so, this method can be reduced to simply:
```typescript
public async ToggleTableColumn(name: string): Promise<boolean> {
await this.btnTableColumn.click();
const result = await element(by.cssContainingText("th", name).isPresent();
await element(by.cssContainingText("label", name)).click();
await this.btnTableColumn.click();
return !result;
}
```
no `if` required
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,26 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ return element(by.cssContainingText("span", name)).isPresent();
+ }
+ public async ToggleTableColumn(name: string): Promise<boolean> {
+ let result = false;
+ await this.btnTableColumn.click();
+ //if it's already on, turn it off and return false
+ if (await browser.isElementPresent(element(by.xpath("//th[text()='" + name + "']"))) === true){
Review comment:
XPath is unfamiliar and confusing - especially because HTML is not an XML dialect, so for some valid HTML XPath queries would be fundamentally incapable of selecting certain tags. Those situations are a bit contrived, but in general web developers are much, much more likely to be familiar with CSS selectors than XPath.
This `by` directive can be written more simply and shorter as just `by.cssContainingText("th", name)`.
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,26 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ return element(by.cssContainingText("span", name)).isPresent();
+ }
+ public async ToggleTableColumn(name: string): Promise<boolean> {
+ let result = false;
+ await this.btnTableColumn.click();
+ //if it's already on, turn it off and return false
+ if (await browser.isElementPresent(element(by.xpath("//th[text()='" + name + "']"))) === true){
+ await element(by.xpath("//label[text()=' " + name + "']")).click();
+ result = false;
+ }else{
+ //of it already off, turn it on return true
+ await element(by.xpath("//label[text()=' " + name + "']")).click();
Review comment:
same as above RE: XPath
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,26 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ return element(by.cssContainingText("span", name)).isPresent();
+ }
+ public async ToggleTableColumn(name: string): Promise<boolean> {
+ let result = false;
+ await this.btnTableColumn.click();
+ //if it's already on, turn it off and return false
+ if (await browser.isElementPresent(element(by.xpath("//th[text()='" + name + "']"))) === true){
+ await element(by.xpath("//label[text()=' " + name + "']")).click();
Review comment:
same as above RE: XPath
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] dpham692 commented on a change in pull request #5845: Migrate cache group test from E2E to integration test
Posted by GitBox <gi...@apache.org>.
dpham692 commented on a change in pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845#discussion_r636491961
##########
File path: traffic_portal/test/integration/specs/CacheGroup.spec.ts
##########
@@ -41,20 +41,38 @@ cachegroups.tests.forEach(cacheGroupData => {
await cacheGroupPage.OpenTopologyMenu();
await cacheGroupPage.OpenCacheGroupsPage();
})
+ cacheGroupData.check.forEach(check => {
+ it(check.description, async () => {
+ expect(await cacheGroupPage.CheckCSV(check.Name)).toBeTruthy();
Review comment:
Fixed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] dpham692 commented on a change in pull request #5845: Migrate cache group test from E2E to integration test
Posted by GitBox <gi...@apache.org>.
dpham692 commented on a change in pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845#discussion_r636491669
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -117,16 +116,15 @@ export class CacheGroupPage extends BasePage {
if (cachegroup.Type == "EDGE_LOC") {
const name = cachegroup.FailoverCG + this.randomize;
await this.txtFailoverCG.click();
- if(await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)))){
- await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)).click();
- }else{
+ if (await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)))) {
Review comment:
Fixed.
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -117,16 +116,15 @@ export class CacheGroupPage extends BasePage {
if (cachegroup.Type == "EDGE_LOC") {
const name = cachegroup.FailoverCG + this.randomize;
await this.txtFailoverCG.click();
- if(await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)))){
- await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="`+ name + `"]`)).click();
- }else{
+ if (await browser.isElementPresent(element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)))) {
+ await element(by.xpath(`//select[@name="fallbackOptions"]//option[@label="` + name + `"]`)).click();
+ } else {
result = undefined;
}
}
await this.txtType.sendKeys(cachegroup.Type);
await snp.ClickUpdate();
- if(result != undefined)
- {
+ if (result != undefined) {
Review comment:
Fixed.
##########
File path: traffic_portal/test/integration/PageObjects/CacheGroup.po.ts
##########
@@ -158,6 +156,31 @@ export class CacheGroupPage extends BasePage {
await snp.NavigateToCacheGroupsPage();
return result;
}
+ public async CheckCSV(name: string): Promise<boolean> {
+ let linkName = name;
+ let result = false;
+ if (await browser.isElementPresent(element(by.xpath("//span[text()='" + linkName + "']"))) == true) {
+ result = true;
+ }
+ return result;
+ }
Review comment:
Fixed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 merged pull request #5845: Migrate cache group test from E2E to integration test
Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #5845:
URL: https://github.com/apache/trafficcontrol/pull/5845
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org