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/01/14 18:44:10 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4293: tc
package: Split enum into its own package
zrhoffman opened a new pull request #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293
<!--
************ 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 -->
This PR splits `enum.go` within the `tc` library into its own package. Reasons for doing this:
* Looking at the line count of source files in the `tc` package (`wc -l *.go | sort -g`), `enum.go` is 727 lines, more lines than the next-longest file in the package (`deliveryservices.go`) by 122 lines. Excluding tests and vendor files, only 10 go sources (out of 584) in the whole project are longer than this.
* [The godoc for the `tc` package](https://godoc.org/github.com/apache/trafficcontrol/lib/go-tc) currently begins with this line:
> Package enum contains enumerations and strongly typed names.
Behavior should be unchanged by this PR, and the documentation contains no references to the `tc` library or `enum.go`, so changes to documentation are not necessary.
Because no code is added, existing tests are sufficient.
## 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 Monitor
- Traffic Ops
- Traffic Ops ORT
- Experimental - Traffic Router Golang
## 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 Go unit tests
* Run Traffic Ops API tests
* Run Traffic Monitor unit tests
* Run atstccfg unit tests
* Run Traffic Router Golang's unit test
## 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] I have explained why tests in this PR are unnecessary
- [x] This PR includes documentation OR I have explained why documentation is unnecessary
- [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)
## 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).
-->
The contents of 9010b50, the package rename itself, is a result of using Goland's "refactor" feature to move `enum.go`.
<!--
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on issue #4293: tc package:
Split enum into its own package
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293#issuecomment-574372586
I can see the benefit of a short package name like `tc`. I'll submit an issue for the GoDoc and open a PR for breaking that file into multiple files later on.
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] rob05c edited a comment on issue #4293: tc
package: Split enum into its own package
Posted by GitBox <gi...@apache.org>.
rob05c edited a comment on issue #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293#issuecomment-574356841
Personally, I'd really prefer we kept this stuff in `tc`. It's used so much in so many places, it makes the code much terser to have e.g. `tc.DeliveryServiceName` everywhere than `enum.DeliveryServiceName`. The brevity was a big part of naming it `tc`.
I think it's also good to keep as much as we can in a library that indicates it's Traffic Control, so it's easy for people not intricately familiar with the code to immediately see it's ours and not a third-party. And we could do something like `tcenum.DeliveryServiceName`, but that's even more verbose.
> enum.go is 727 lines
I wouldn't object to breaking that file into multiple files, though.
>The godoc for the tc package currently begins with this line:
> Package enum contains enumerations and strongly typed names.
That's a bug, we should definitely fix the GoDoc.
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] rob05c edited a comment on issue #4293: tc
package: Split enum into its own package
Posted by GitBox <gi...@apache.org>.
rob05c edited a comment on issue #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293#issuecomment-574356841
Personally, I'd really prefer we kept this stuff in `tc`. It's used so much in so many places, it makes the code much terser to have e.g. `tc.DeliveryServiceName` everywhere than `enum.DeliveryServiceName`. The brevity was a big part of naming it `tc`.
I think it's also good to keep as much as we can in a library that indicates it's Traffic Control, so it's easy for people not intricately familiar with the code to immediately see it's ours and not a third-party. And we could do something like `tcenum.DeliveryServiceName`, but that's even more verbose.
> enum.go is 727 lines
I wouldn't object to breaking that file into multiple files, though.
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman closed pull request #4293: tc package:
Split enum into its own package
Posted by GitBox <gi...@apache.org>.
zrhoffman closed pull request #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] rob05c commented on issue #4293: tc package: Split
enum into its own package
Posted by GitBox <gi...@apache.org>.
rob05c commented on issue #4293: tc package: Split enum into its own package
URL: https://github.com/apache/trafficcontrol/pull/4293#issuecomment-574356841
Personally, I'd really prefer we kept this stuff in `tc`. It's used so much in so many places, it makes the code much terser to have e.g. `tc.DeliveryServiceName` everywhere than `enum.DeliveryServiceName`. The brevity was a big part of naming it `tc`.
I think it's also good to keep as much as we can in a library that indicates it's Traffic Control, so it's easy for people not intricately familiar with the code to immediately see it's ours and not a third-party. And we could do something like `tcenum.DeliveryServiceName`, but that's even more verbose.
----------------------------------------------------------------
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
With regards,
Apache Git Services