Standardized url generator for taskcluster resources.
Project description
Taskcluster URL Building Library
A simple library to generate URLs for various Taskcluster resources across our various deployment methods.
This serves as both a simple shim for projects that use JavaScript but also is the reference implementation for how we define these paths.
URLs are defined in the 'Taskcluster URL Format' document.
Changelog
View the changelog on the releases page.
Requirements
This is tested on and should run on any of Node.js {8, 10}
.
JS Usage
This package exports several methods for generating URLs conditionally based on a root URL, as well as a few helper classes for generating URLs for a pre-determined root URL:
api(rootUrl, service, version, path)
->String
apiReference(rootUrl, service, version)
->String
docs(rootUrl, path)
->String
exchangeReference(rootUrl, service, version)
->String
schema(rootUrl, service, schema)
->String
ui(rootUrl, path)
->String
servicesManifest(rootUrl)
->String
testRootUrl()
->String
withRootUrl(rootUrl)
->Class
instance for above methods
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.
testRootUrl
is used to share a common rootUrl
between various Taskcluster mocks in testing.
// Specifying root URL every time:
const libUrls = require('taskcluster-lib-urls');
libUrls.api(rootUrl, 'auth', 'v1', 'foo/bar');
libUrls.schema(rootUrl, 'auth', 'v1/foo.yml'); // Note that schema names have versions in them
libUrls.apiReference(rootUrl, 'auth', 'v1');
libUrls.exchangeReference(rootUrl, 'auth', 'v1');
libUrls.ui(rootUrl, 'foo/bar');
libUrls.servicesManifest(rootUrl);
libUrls.docs(rootUrl, 'foo/bar');
// Specifying root URL in advance:
const libUrls = require('taskcluster-lib-urls');
const urls = libUrls.withRoot(rootUrl);
urls.api('auth', 'v1', 'foo/bar');
urls.schema('auth', 'v1/foo.yml');
urls.apiReference('auth', 'v1');
urls.exchangeReference('auth', 'v1');
urls.ui('foo/bar');
urls.servicesManifest();
urls.docs('foo/bar');
If you would like, you can set this up via taskcluster-lib-loader as follows:
{
libUrlss: {
require: ['cfg'],
setup: ({cfg}) => withRootUrl(cfg.rootURl),
},
}
Go Usage
The go package exports the following functions:
func API(rootURL string, service string, version string, path string) string
func APIReference(rootURL string, service string, version string) string
func Docs(rootURL string, path string) string
func ExchangeReference(rootURL string, service string, version string) string
func Schema(rootURL string, service string, name string) string
func UI(rootURL string, path string) string
func ServicesManifest(rootURL string) string
Python Usage
You can install the python client with pip install taskcluster-urls
;
import taskcluster_urls
taskcluster_urls.api(root_url, 'auth', 'v1', 'foo/bar')
taskcluster_urls.schema(root_url, 'auth', 'v1/foo.yml') # Note that schema names have versions in them
taskcluster_urls.api_reference(root_url, 'auth', 'v1')
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')
Testing
yarn install
and yarn test
.
Hacking
New releases should be tested on Travis to allow for all supported versions of Node to be tested. Once satisfied that it works, new versions should be created with
yarn version
rather than by manually editing package.json
and tags should be pushed to Github. Make sure to update the changelog!
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for taskcluster_urls-10.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a26f33f948c8c1820f9b7992d9964a10462729b4bd223565a5f19df828c09ce |
|
MD5 | 5647f17d8a29e1810bc23505f6fa838b |
|
BLAKE2b-256 | 806837c490004278adcc0cb06740a7371ed6fdb147df3f5b03ab989474e614d5 |
Hashes for taskcluster_urls-10.1.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c15459df52813c21312b8dc608df8f5069cb47a7114946738d953c3d383f4a0b |
|
MD5 | 6988b5451cf1e02102eb369cb507bcab |
|
BLAKE2b-256 | c273b455053b1cf83dbbbad757e787241a36e174ea56b4a0757187055ae9a0ba |