[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #4630: Updating the testing documentation for TO to add more info about buil…

[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