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/04/10 21:27:10 UTC
[GitHub] [trafficcontrol] srijeet0406 opened a new pull request #4630: Updating the testing documentation for TO to add more info about buil…
srijeet0406 opened a new pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630
…d steps
<!--
************ 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 #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
I was trying to get the TO golang tests up and running on my local machine. I felt adding a couple of examples and links to some of the steps would help someone else doing this in the future.
## 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. -->
- Documentation
- Traffic Ops (Golang 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. -->
N/A, only documentation fixes.
## 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!
-->
- [ ] 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] An update to CHANGELOG.md is not necessary
- [ ] This PR includes any and all required license headers
- [ ] This PR ensures that database migration sequence is correct OR 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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408496471
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -60,7 +84,49 @@ In order to run the tests you will need the following:
change `traffic_ops_golang->port` to 8443
`$ go build && ./traffic_ops_golang -cfg $HOME/cdn.conf -dbcfg ../app/conf/test/database.conf`
-
+
+ In your local development environment, if the above command fails for an error similar to
+ `ERROR: traffic_ops_golang.go:193: 2020-04-10T10:55:53.190298-06:00: cannot open /etc/pki/tls/certs/localhost.crt for read: open /etc/pki/tls/certs/localhost.crt: no such file or directory`
+ you might not have the right certificates at the right locations. Follow the following procedure
+ to fix it:
+ ```bash
+ $ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
Review comment:
In that case, no need to include any of the OpenSSL stuff in the readme, we can just link to the docs.
----------------------------------------------------------------
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] rawlinp merged pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
rawlinp merged pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630
----------------------------------------------------------------
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 a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408367367
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -60,7 +84,49 @@ In order to run the tests you will need the following:
change `traffic_ops_golang->port` to 8443
`$ go build && ./traffic_ops_golang -cfg $HOME/cdn.conf -dbcfg ../app/conf/test/database.conf`
-
+
+ In your local development environment, if the above command fails for an error similar to
+ `ERROR: traffic_ops_golang.go:193: 2020-04-10T10:55:53.190298-06:00: cannot open /etc/pki/tls/certs/localhost.crt for read: open /etc/pki/tls/certs/localhost.crt: no such file or directory`
+ you might not have the right certificates at the right locations. Follow the following procedure
+ to fix it:
+ ```bash
+ $ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
Review comment:
Running this command, I get
```shell
[user@computer c]$ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
Generating RSA private key, 2048 bit long modulus (2 primes)
...................................................+++++
....+++++
e is 65537 (0x010001)
140415293105472:error:28078065:UI routines:UI_set_result_ex:result too small:crypto/ui/ui_lib.c:905:You must type in 4 to 1023 characters
140415293105472:error:28078065:UI routines:UI_set_result_ex:result too small:crypto/ui/ui_lib.c:905:You must type in 4 to 1023 characters
140415293105472:error:0906906F:PEM routines:PEM_ASN1_write_bio:read key:crypto/pem/pem_lib.c:357:
```
A file named `localhost.pass.key` is generated, but it is empty. Instead of separtely generating a private key and CSR and then signing it, you can generate a private key and cert with
```shell
openssl req -new -x509 -newkey rsa:4096 -nodes -out cert.crt -keyout cert.key -subj "/CN=*"
```
Should the cert section use that command instead?
----------------------------------------------------------------
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] srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408494927
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -41,7 +41,31 @@ In order to run the tests you will need the following:
and here: `traffic-ops-test.conf`
The Traffic Ops users will be created by the tool for accessing the API once the database is accessible.
-
+
+ Note that for the database to successfully set up the tables and run the migrations, you will need `goose`.
+ On your local machines(Macs), DO NOT install `goose` using `homebrew`. It will install another non compliant
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408494892
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -60,7 +84,49 @@ In order to run the tests you will need the following:
change `traffic_ops_golang->port` to 8443
`$ go build && ./traffic_ops_golang -cfg $HOME/cdn.conf -dbcfg ../app/conf/test/database.conf`
-
+
+ In your local development environment, if the above command fails for an error similar to
+ `ERROR: traffic_ops_golang.go:193: 2020-04-10T10:55:53.190298-06:00: cannot open /etc/pki/tls/certs/localhost.crt for read: open /etc/pki/tls/certs/localhost.crt: no such file or directory`
+ you might not have the right certificates at the right locations. Follow the following procedure
+ to fix it:
+ ```bash
+ $ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
Review comment:
Yes, that command will work too. I was following the instructions at https://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops.html#id12
----------------------------------------------------------------
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 a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408370253
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -41,7 +41,31 @@ In order to run the tests you will need the following:
and here: `traffic-ops-test.conf`
The Traffic Ops users will be created by the tool for accessing the API once the database is accessible.
-
+
+ Note that for the database to successfully set up the tables and run the migrations, you will need `goose`.
+ On your local machines(Macs), DO NOT install `goose` using `homebrew`. It will install another non compliant
Review comment:
I wouldn't call it non-compliant, it's just the more popular [pressly/goose](https://github.com/pressly/goose) fork instead of the unmaintained https://bitbucket.org/liamstask/goose version that we use. Can this change to saying that Homebrew installs an unsupported goose version, or that Homebrew installs a different "goose"?
----------------------------------------------------------------
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] rawlinp commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408512278
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -41,7 +41,31 @@ In order to run the tests you will need the following:
and here: `traffic-ops-test.conf`
The Traffic Ops users will be created by the tool for accessing the API once the database is accessible.
-
+
+ Note that for the database to successfully set up the tables and run the migrations, you will need `goose`.
+ On your local machines(Macs), DO NOT install `goose` using `homebrew`. It will install a different version
+ `goose`. Instead, install it using the script located at
+ `traffic_ops/install/bin/install_goose.sh`.
+ To test if `goose` migrated everything correctly, you can run the following command from the `traffic_ops/app`
+ directory:
+ `goose -env=test status "user=traffic_ops dbname=to_test sslmode=disable"`
+
+ The result should be something similar to:
+ `goose: status for environment 'test'
Review comment:
I think this output should be wrapped in triple backticks like this:
\```
asdf
\```
otherwise it doesn't render as preformatted text
----------------------------------------------------------------
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] srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408498575
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -60,7 +84,49 @@ In order to run the tests you will need the following:
change `traffic_ops_golang->port` to 8443
`$ go build && ./traffic_ops_golang -cfg $HOME/cdn.conf -dbcfg ../app/conf/test/database.conf`
-
+
+ In your local development environment, if the above command fails for an error similar to
+ `ERROR: traffic_ops_golang.go:193: 2020-04-10T10:55:53.190298-06:00: cannot open /etc/pki/tls/certs/localhost.crt for read: open /etc/pki/tls/certs/localhost.crt: no such file or directory`
+ you might not have the right certificates at the right locations. Follow the following procedure
+ to fix it:
+ ```bash
+ $ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
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
With regards,
Apache Git Services
[GitHub] [trafficcontrol] srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
Posted by GitBox <gi...@apache.org>.
srijeet0406 commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…
URL: https://github.com/apache/trafficcontrol/pull/4630#discussion_r408571877
##########
File path: traffic_ops/testing/api/README.md
##########
@@ -41,7 +41,31 @@ In order to run the tests you will need the following:
and here: `traffic-ops-test.conf`
The Traffic Ops users will be created by the tool for accessing the API once the database is accessible.
-
+
+ Note that for the database to successfully set up the tables and run the migrations, you will need `goose`.
+ On your local machines(Macs), DO NOT install `goose` using `homebrew`. It will install a different version
+ `goose`. Instead, install it using the script located at
+ `traffic_ops/install/bin/install_goose.sh`.
+ To test if `goose` migrated everything correctly, you can run the following command from the `traffic_ops/app`
+ directory:
+ `goose -env=test status "user=traffic_ops dbname=to_test sslmode=disable"`
+
+ The result should be something similar to:
+ `goose: status for environment 'test'
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
With regards,
Apache Git Services