Merge pull request #16 from djmitche/add-test-url-py

Add test_root_url in Python

Author: djmitche

README.md

@@ -40,7 +40,8 @@ root URL:
 When the `rootUrl` is `https://taskcluster.net`, the generated URLs will be to the Heroku cluster. Otherwise they will follow the
 [spec defined in this project](https://github.com/taskcluster/taskcluster-lib-urls/tree/master/docs/urls-spec.md).
 
-`testRootUrl` is used to share a common `rootUrl` between various Taskcluster mocks in testing.
+`testRootUrl()` is used to share a common fake `rootUrl` between various Taskcluster mocks in testing.
+The URL does not resolve.
 
 ```js
 // Specifying root URL every time:
@@ -133,6 +134,10 @@ taskcluster_urls.exchange_reference(root_url, 'auth', 'v1')
 taskcluster_urls.ui(root_url, 'foo/bar')
 taskcluster_urls.servicesManifest(root_url)
 taskcluster_urls.docs(root_url, 'foo/bar')
+
+And for testing,
+```python
+taskcluster_urls.test_root_url()
 ```
 
 Test with:

src/index.js

@@ -193,6 +193,6 @@ module.exports = {
    * Useful for nock and such things.
    */
   testRootUrl() {
-    return 'https://tc-tests.localhost';
+    return 'https://tc-tests.example.com';
   },
 };

taskcluster_urls/__init__.py

@@ -59,3 +59,8 @@ def services_manifest(root_url):
         return 'https://references.taskcluster.net/manifest.json'
     else:
         return '{}/references/manifest.json'.format(root_url)
+
+def test_root_url():
+    """Returns a standardized "testing" rootUrl that does not resolve but
+    is easily recognizable in test failures."""
+    return 'https://tc-tests.example.com'