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/15 16:58:24 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4694: More Topologies validation
zrhoffman opened a new pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694
<!--
************ 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 fixes #4691 by checking whether a parent node's index exists<!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
- This PR fixes a bug by only performing further validation on a topology if all of its nodes' cachegroups exist
- Adds a status code check to the negative API tests to enure that POSTing invalid topologies returns only 400-level response status codes, not 500-level
## 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 Control Client (Go)<!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
- 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 Traffic Ops API tests, verify they still pass:
```shell script
docker-compose -f docker-compose.yml -f docker-compose.traffic-ops-test.yml up
```
## 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 (88f4f2aad0)
- 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).
-->
- master (88f4f2aad0)
## 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] This PR is a bugfix, no documentation necessary
- [x] An update to CHANGELOG.md is not necessary
- [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)
<!--
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] rawlinp commented on a change in pull request #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428786482
##########
File path: traffic_ops/client/topology.go
##########
@@ -30,94 +30,118 @@ const (
)
// CreateTopology creates a topology and returns the response.
-func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error) {
- var remoteAddr net.Addr
+func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error, int) {
+ var (
+ statusCode = http.StatusNotAcceptable
+ remoteAddr net.Addr
+ )
reqBody, err := json.Marshal(top)
reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
if err != nil {
- return nil, reqInf, err
+ return nil, reqInf, err, statusCode
Review comment:
Did you not want to start setting the status code in `ReqInf` in these Topologies methods? Or that likely means having to update all of its usage throughout the entire TO client?
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428937920
##########
File path: traffic_ops/traffic_ops_golang/topology/validation.go
##########
@@ -57,9 +57,14 @@ func checkForEdgeParents(nodes []tc.TopologyNode, cachegroups []tc.CacheGroupNul
node := nodes[nodeIndex]
errs := make([]error, len(node.Parents))
for parentIndex := range node.Parents {
- cacheGroupType := cachegroups[node.Parents[parentIndex]].Type
+ cachegroupIndex := node.Parents[parentIndex]
Review comment:
Changed in 38838fa76
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428858890
##########
File path: traffic_ops/client/topology.go
##########
@@ -30,94 +30,118 @@ const (
)
// CreateTopology creates a topology and returns the response.
-func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error) {
- var remoteAddr net.Addr
+func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error, int) {
+ var (
+ statusCode = http.StatusNotAcceptable
+ remoteAddr net.Addr
+ )
reqBody, err := json.Marshal(top)
reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
if err != nil {
- return nil, reqInf, err
+ return nil, reqInf, err, statusCode
Review comment:
Let's do it. Setting the status code in 481038d58a.
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428935881
##########
File path: traffic_ops/client/session.go
##########
@@ -307,7 +307,7 @@ func NewNoAuthSession(toURL string, insecure bool, userAgent string, useCache bo
}, useCache)
}
-// ErrUnlessOk returns nil and an error if the given Response's status code is anything but 200 OK. This includes reading the Response.Body and Closing it. Otherwise, the given response and error are returned unchanged.
+// ErrUnlessOk returns the response an error if the given Response's status code is anything but 200 OK. This includes reading the Response.Body and Closing it. Otherwise, the given response and a nil error are returned.
Review comment:
Thanks, fixed the typo and mentioned the remote address in 971302817.
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428227419
##########
File path: traffic_ops/client/topology.go
##########
@@ -30,94 +30,118 @@ const (
)
// CreateTopology creates a topology and returns the response.
-func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error) {
- var remoteAddr net.Addr
+func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error, int) {
+ var (
+ statusCode = http.StatusNotAcceptable
+ remoteAddr net.Addr
+ )
reqBody, err := json.Marshal(top)
reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
if err != nil {
- return nil, reqInf, err
+ return nil, reqInf, err, statusCode
Review comment:
Following that pattern in c1140e42f4
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r427655628
##########
File path: traffic_ops/client/topology.go
##########
@@ -30,94 +30,118 @@ const (
)
// CreateTopology creates a topology and returns the response.
-func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error) {
- var remoteAddr net.Addr
+func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error, int) {
+ var (
+ statusCode = http.StatusNotAcceptable
+ remoteAddr net.Addr
+ )
reqBody, err := json.Marshal(top)
reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
if err != nil {
- return nil, reqInf, err
+ return nil, reqInf, err, statusCode
Review comment:
Based on the mailing list discussion it sounds like consensus has been built around adding the status code to the `ReqInf` struct and returning it that way, so we should start following that pattern for these methods. Then in a separate PR someone could retroactively add the status code to `ReqInf` for the rest of the TO Go client methods.
----------------------------------------------------------------
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] srijeet0406 commented on a change in pull request #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
srijeet0406 commented on a change in pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694#discussion_r428921275
##########
File path: traffic_ops/client/session.go
##########
@@ -307,7 +307,7 @@ func NewNoAuthSession(toURL string, insecure bool, userAgent string, useCache bo
}, useCache)
}
-// ErrUnlessOk returns nil and an error if the given Response's status code is anything but 200 OK. This includes reading the Response.Body and Closing it. Otherwise, the given response and error are returned unchanged.
+// ErrUnlessOk returns the response an error if the given Response's status code is anything but 200 OK. This includes reading the Response.Body and Closing it. Otherwise, the given response and a nil error are returned.
Review comment:
Should be `the response and an error`
Also, shouldn't the comment say that this function returns three things?
##########
File path: traffic_ops/traffic_ops_golang/topology/validation.go
##########
@@ -57,9 +57,14 @@ func checkForEdgeParents(nodes []tc.TopologyNode, cachegroups []tc.CacheGroupNul
node := nodes[nodeIndex]
errs := make([]error, len(node.Parents))
for parentIndex := range node.Parents {
- cacheGroupType := cachegroups[node.Parents[parentIndex]].Type
+ cachegroupIndex := node.Parents[parentIndex]
Review comment:
This could be a part of the `range` statement above, wherein you'd get the index and the value in the step.
----------------------------------------------------------------
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 #4694: More Topologies validation
Posted by GitBox <gi...@apache.org>.
rawlinp merged pull request #4694:
URL: https://github.com/apache/trafficcontrol/pull/4694
----------------------------------------------------------------
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