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 2020/05/20 22:30:26 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4707: Add an API test for DELETE /regions?name={{name}}
zrhoffman opened a new pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707
<!--
************ 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 complements #4357's fix for #3819 by adding an API test.<!-- 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. -->
- Traffic Ops
## 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. -->
Run the API tests, make sure they pass
```shell script
docker-compose -f docker-compose.yml -f docker-compose.traffic-ops-test.yml up -d && \
docker-compose -f docker-compose.yml -f docker-compose.traffic-ops-test.yml logs -f integration
```
## 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).
-->
Not a bug fix.
## 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
- [x] Documentation already exists, including docs in the PR is unnecessary
- [x] This PR includes an update to CHANGELOG.md
- [x] This PR includes any and all required license headers
- [x] This PR does not include a database migration
- [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] zrhoffman commented on a change in pull request #4707: Add and satisfy OptionsDelete API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428987738
##########
File path: traffic_ops/traffic_ops_golang/api/shared_handlers.go
##########
@@ -390,30 +416,34 @@ func DeprecatedDeleteHandler(deleter Deleter, alternative *string) http.HandlerF
obj := reflect.New(objectType).Interface().(Deleter)
obj.SetInfo(inf)
- deleteKeyOptionExists, userErr, sysErr, errCode := hasDeleteKeyOption(obj, inf.Params)
+ isOptionsDeleter, userErr, sysErr, errCode := checkIfOptionsDeleter(obj, inf.Params)
if userErr != nil || sysErr != nil {
HandleDeprecatedErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr, alternative)
return
}
- if !deleteKeyOptionExists {
- keyFields := obj.GetKeyFieldsInfo() // expecting a slice of the key fields info which is a struct with the field name and a function to convert a string into a interface{} of the right type. in most that will be [{Field:"id",Func: func(s string)(interface{},error){return strconv.Atoi(s)}}]
- keys := make(map[string]interface{})
- for _, kf := range keyFields {
- paramKey := inf.Params[kf.Field]
- if paramKey == "" {
- HandleDeprecatedErr(w, r, inf.Tx.Tx, http.StatusBadRequest, errors.New("missing key: "+kf.Field), nil, alternative)
- return
+ keyFields := obj.GetKeyFieldsInfo() // expecting a slice of the key fields info which is a struct with the field name and a function to convert a string into a interface{} of the right type. in most that will be [{Field:"id",Func: func(s string)(interface{},error){return strconv.Atoi(s)}}]
Review comment:
Right you are. Parity kept in 0c60881ce.
----------------------------------------------------------------
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] shamrickus commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
shamrickus commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428358112
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
Should we be adding test changes to the changelog?
----------------------------------------------------------------
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] rawlinp commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428366496
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
I don't think so. The audience for the changelog probably doesn't need to know about every single test added ¯\\\_(ツ)\_/¯
----------------------------------------------------------------
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] zrhoffman commented on pull request #4707: Add and satisfy OptionsDelete API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#issuecomment-632362413
The audit log for `DELETE /regions?name={{name}}` is fixed in d77345814a, and audit log assertions for that route are added to the API tests in a8f72f6d6f.
----------------------------------------------------------------
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] rawlinp merged pull request #4707: Add and satisfy OptionsDelete API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
rawlinp merged pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707
----------------------------------------------------------------
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] rawlinp commented on a change in pull request #4707: Add and satisfy OptionsDelete API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428980079
##########
File path: traffic_ops/traffic_ops_golang/api/shared_handlers.go
##########
@@ -390,30 +416,34 @@ func DeprecatedDeleteHandler(deleter Deleter, alternative *string) http.HandlerF
obj := reflect.New(objectType).Interface().(Deleter)
obj.SetInfo(inf)
- deleteKeyOptionExists, userErr, sysErr, errCode := hasDeleteKeyOption(obj, inf.Params)
+ isOptionsDeleter, userErr, sysErr, errCode := checkIfOptionsDeleter(obj, inf.Params)
if userErr != nil || sysErr != nil {
HandleDeprecatedErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr, alternative)
return
}
- if !deleteKeyOptionExists {
- keyFields := obj.GetKeyFieldsInfo() // expecting a slice of the key fields info which is a struct with the field name and a function to convert a string into a interface{} of the right type. in most that will be [{Field:"id",Func: func(s string)(interface{},error){return strconv.Atoi(s)}}]
- keys := make(map[string]interface{})
- for _, kf := range keyFields {
- paramKey := inf.Params[kf.Field]
- if paramKey == "" {
- HandleDeprecatedErr(w, r, inf.Tx.Tx, http.StatusBadRequest, errors.New("missing key: "+kf.Field), nil, alternative)
- return
+ keyFields := obj.GetKeyFieldsInfo() // expecting a slice of the key fields info which is a struct with the field name and a function to convert a string into a interface{} of the right type. in most that will be [{Field:"id",Func: func(s string)(interface{},error){return strconv.Atoi(s)}}]
Review comment:
It looks like the DeprecatedDeleteHandler function didn't get all the same treatment as the DeleteHandler. Before, they were basically identical except for `HandleErr` vs `HandleDeprecatedErr` (before I messed).
We should keep these in parity, right? Until we reduce the duplication here.
----------------------------------------------------------------
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] rawlinp commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428373805
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
Whoops, your comment was added after I started writing mine @zrhoffman. But since this bug is unreleased (as of yet), I don't think the bugfix needs to be in the changelog either.
----------------------------------------------------------------
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] rawlinp commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428366496
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
I don't think so. The audience for the changelog probably doesn't need to know about every single test added ¯\_(ツ)_/¯
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
I don't think so. The audience for the changelog probably doesn't need to know about every single test added ¯\\_(ツ)_/¯
----------------------------------------------------------------
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] zrhoffman commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428374271
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
Okay, changelog entry gone in da68d318a.
----------------------------------------------------------------
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] zrhoffman commented on pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#issuecomment-631809907
This is ready for review.
----------------------------------------------------------------
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] zrhoffman commented on a change in pull request #4707: Add an API test for DELETE /regions?name={{name}}
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4707:
URL: https://github.com/apache/trafficcontrol/pull/4707#discussion_r428363721
##########
File path: CHANGELOG.md
##########
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops: Added an API 3.0 endpoint, /api/3.0/topologies, to create, read, update and delete flexible topologies.
- Traffic Ops: Added support for `topology` query parameter to `GET /api/3.0/cachegroups` to return all cachegroups used in the given topology.
- Traffic Portal: Added the ability to create, read, update and delete flexible topologies.
+- Added an API test for `DELETE /api/3.0/regions?name={{name}}`
Review comment:
This API test currently fails due to a regression in #4704. This PR will is intended to include a fix, and bugfixes should be included in the changelog. When the fix is pushed, I'll update the existing changelog entry instead of adding a new one.
----------------------------------------------------------------
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