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/11/19 21:28:19 UTC
[GitHub] [trafficcontrol] MylesBock opened a new pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
MylesBock opened a new pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312
Closes #5301
- necessary consts moved into `traffic_ops_golang/server/servers_assignment.go`
- `GetConfigFile` added to `traffic_ops_golang/server/servers_assignment.go` and renamed to `getConfigFile` (isn't used elsewhere in package)
Does not seem to require updating any tests, nor does there seem to be any specific documentation related to this that needs updated.
Will update `CHANGELOG` if required, there should also be some corresponding documentation surrounding updating the consts that were moved over.
<!--
************ 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 #5301 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.
-->
- [ ] This PR fixes #REPLACE_ME OR 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
- Documentation
- Grove
- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
- Traffic Monitor
- [x] Traffic Ops
- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
- Traffic Vault
- 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. -->
Intentionally break `go-atscfg` and ensure `traffic_ops_golang` still builds and performs expected duties
## 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
- [x] This PR includes documentation OR I have explained why documentation is unnecessary
- [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
- [x] 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] MylesBock commented on a change in pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527551932
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -269,7 +277,9 @@ INSERT INTO deliveryservice_server (deliveryservice, server)
//need remap config location
var atsConfigLocation string
- if err := tx.QueryRow("SELECT value FROM parameter WHERE name = 'location' AND config_file = '" + atscfg.RemapFile + "'").Scan(&atsConfigLocation); err != nil {
+ if err := tx.QueryRow("SELECT value FROM parameter " +
+ "WHERE name = 'location'" +
+ " AND config_file = '" + RemapFile + "'").Scan(&atsConfigLocation); err != nil {
Review comment:
I think it's a style guide thing I missed that they adhere to? Probably could be configured but this is a mostly stock installation
----------------------------------------------------------------
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 #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527250619
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -57,6 +56,15 @@ FROM deliveryservice
LEFT OUTER JOIN cdn ON cdn.id=deliveryservice.cdn_id
WHERE deliveryservice.id = ANY($1)
`
+const RemapFile = "remap.config"
+const ConfigSuffix = ".config"
+const RegexRemapPrefix = "regex_remap_"
+const CacheUrlPrefix = "cacheurl_"
+const HeaderRewritePrefix = "hdr_rw_"
Review comment:
These can all be function-level constants, right?
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -269,7 +277,9 @@ INSERT INTO deliveryservice_server (deliveryservice, server)
//need remap config location
var atsConfigLocation string
- if err := tx.QueryRow("SELECT value FROM parameter WHERE name = 'location' AND config_file = '" + atscfg.RemapFile + "'").Scan(&atsConfigLocation); err != nil {
+ if err := tx.QueryRow("SELECT value FROM parameter " +
+ "WHERE name = 'location'" +
+ " AND config_file = '" + RemapFile + "'").Scan(&atsConfigLocation); err != nil {
Review comment:
Nit: If this is going to be a multi-line string, you can use backticks instead of double quotes to remove 2 concatenations.
----------------------------------------------------------------
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 #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527352723
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -57,6 +56,15 @@ FROM deliveryservice
LEFT OUTER JOIN cdn ON cdn.id=deliveryservice.cdn_id
WHERE deliveryservice.id = ANY($1)
`
+const RemapFile = "remap.config"
+const ConfigSuffix = ".config"
+const RegexRemapPrefix = "regex_remap_"
+const CacheUrlPrefix = "cacheurl_"
+const HeaderRewritePrefix = "hdr_rw_"
Review comment:
We should keep those string literals as constants, we don't want to have random string fragments with no explanation of their purpose.
----------------------------------------------------------------
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 merged pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
zrhoffman merged pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312
----------------------------------------------------------------
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] MylesBock commented on pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#issuecomment-730802191
> `atscfg.GetConfigFile()` can just be removed now that it's unused.
Done, also marked a few other unused functions and a constant in that file if a breakout issue is desired
----------------------------------------------------------------
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] MylesBock commented on a change in pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527350852
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -269,7 +277,9 @@ INSERT INTO deliveryservice_server (deliveryservice, server)
//need remap config location
var atsConfigLocation string
- if err := tx.QueryRow("SELECT value FROM parameter WHERE name = 'location' AND config_file = '" + atscfg.RemapFile + "'").Scan(&atsConfigLocation); err != nil {
+ if err := tx.QueryRow("SELECT value FROM parameter " +
+ "WHERE name = 'location'" +
+ " AND config_file = '" + RemapFile + "'").Scan(&atsConfigLocation); err != nil {
Review comment:
Done, goland did this multiline concatenation for me and that really isn't nitpicking it will highlight the backtick delimited string appropriately unlike the previous string
----------------------------------------------------------------
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] MylesBock commented on a change in pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527350642
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -57,6 +56,15 @@ FROM deliveryservice
LEFT OUTER JOIN cdn ON cdn.id=deliveryservice.cdn_id
WHERE deliveryservice.id = ANY($1)
`
+const RemapFile = "remap.config"
+const ConfigSuffix = ".config"
+const RegexRemapPrefix = "regex_remap_"
+const CacheUrlPrefix = "cacheurl_"
+const HeaderRewritePrefix = "hdr_rw_"
Review comment:
Sure they could, I inlined them in the latest commit
----------------------------------------------------------------
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 edited a comment on pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
zrhoffman edited a comment on pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#issuecomment-730804341
> > `atscfg.GetConfigFile()` can just be removed now that it's unused.
>
> Done, also marked a few other unused functions and a constant in that file if a breakout issue is desired
If those other functions are not related to the issue that this PR fixes, we should leave them untouched.
----------------------------------------------------------------
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] MylesBock commented on pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#issuecomment-731378833
:+1: thanks for having me!
----------------------------------------------------------------
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] MylesBock commented on a change in pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527380329
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -57,6 +56,15 @@ FROM deliveryservice
LEFT OUTER JOIN cdn ON cdn.id=deliveryservice.cdn_id
WHERE deliveryservice.id = ANY($1)
`
+const RemapFile = "remap.config"
+const ConfigSuffix = ".config"
+const RegexRemapPrefix = "regex_remap_"
+const CacheUrlPrefix = "cacheurl_"
+const HeaderRewritePrefix = "hdr_rw_"
Review comment:
Reintroduced as constants at the function level
----------------------------------------------------------------
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] MylesBock commented on pull request #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
MylesBock commented on pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#issuecomment-731344936
> > > `atscfg.GetConfigFile()` can just be removed now that it's unused.
> >
> >
> > Done, also marked a few other unused functions and a constant in that file if a breakout issue is desired
>
> If those other functions are not related to the issue that this PR fixes, we should leave them untouched.
They have remained unaltered until an issue is created calling for their removal
----------------------------------------------------------------
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 #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#issuecomment-730804341
> > `atscfg.GetConfigFile()` can just be removed now that it's unused.
>
> Done, also marked a few other unused functions and a constant in that file if a breakout issue is desired
If those other functions are not related to this PR, we should leave them untouched.
----------------------------------------------------------------
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 #5312: Removing atscfg as a dependency in traffic_ops_golang
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5312:
URL: https://github.com/apache/trafficcontrol/pull/5312#discussion_r527507200
##########
File path: traffic_ops/traffic_ops_golang/server/servers_assignment.go
##########
@@ -269,7 +277,9 @@ INSERT INTO deliveryservice_server (deliveryservice, server)
//need remap config location
var atsConfigLocation string
- if err := tx.QueryRow("SELECT value FROM parameter WHERE name = 'location' AND config_file = '" + atscfg.RemapFile + "'").Scan(&atsConfigLocation); err != nil {
+ if err := tx.QueryRow("SELECT value FROM parameter " +
+ "WHERE name = 'location'" +
+ " AND config_file = '" + RemapFile + "'").Scan(&atsConfigLocation); err != nil {
Review comment:
Goland can't highlight that properly? I expected more from them.
----------------------------------------------------------------
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