Overview | Running | Testing | Releasing | Useful Links
Matterhorn is a device identification service for legacy TVs that attempt to launch iPlayer on the "www.bbc.co.uk/iplayer" domain. For the details of the current usage of Matterhorn, please see iPlayer Web Edge
This service was used as the identification service for all TV devices in the past but the newer devices on "www.live.bbctvapps.co.uk/*" domain use the melanite library directly via Tap Launch Edge.
To update Matterhorn's certs follow the guide here.
- Install docker
npm install
./devSetup.shdocker-compose exec matterhorn npm testWe test our code using Jasmine
& ESlint. Running
npm test will run eslint on your source code, followed by the
jasmine tests.
The Jasmine tests are separated into two categories;
- Spec tests - standard Jasmine unit tests
- Integration tests - tests against upstreams and full app integration
You can run the different test categories separately by running any of the following commands.
docker-compose exec matterhorn npm run test:spec
docker-compose exec matterhorn npm run test:integrationChanges to the pipeline project (private) which configures hosting for Matterhorn are linked via a submodule.
NOTE: you must ensure your local repo clone contains the submodule references - for instance, either explicitly ask for them when cloning:
git clone --recurse-submodules [email protected]:bbc/matterhorn.git
or configure Git to account for submodules by default:
git config --global submodule.recurse true
To update the reference to the submodule, run:
git submodule foreach git pull origin master
Currently the tests are run against each commit. If you want to build to an environment you must first make a tag, before building to TEST and then LIVE in Jenkins. Before depolying to Live, test that the new build is working by hitting the test status endpoint. You can also check the status of the EC2 instances via the AWS console in the IPTV prod and IPTV Dev (198243407611 and 119990297419) for Live and Test respectivly.
A table of useful links for the project.
| Type | Location |
|---|---|
| Status Endpoint (live) | https://connected-tv-service-matterhorn.api.bbci.co.uk/status |
| Status Endpoint (test) | https://connected-tv-service-matterhorn.test.api.bbci.co.uk/status |
| User Agent Endpoint | https://connected-tv-service-matterhorn.api.bbci.co.uk/identify/ua/:ua/json |
| WhoAmI Endpoint | https://connected-tv-service-matterhorn.api.bbci.co.uk/identify/whoami/:whoami/json |
| Build Job | https://ci.itv.tools.bbc.co.uk/job/launch/job/matterhorn/job/build/ |
| Deploy Job | https://ci.itv.tools.bbc.co.uk/job/launch/job/matterhorn/job/deploy/ |
| Cosmos Service | https://cosmos.tools.bbc.co.uk/services/matterhorn |
| Melanite Library | https://github.com/bbc/melanite |
| Device Identification Data | https://github.com/bbc/device-identification-data |
| TAL | https://github.com/bbc/tal |
Matterhorn is available to everyone under the terms of the Apache 2.0 open source licence. Take a look at the LICENSE file in the code, and read our faq and documentation to learn how to contribute.
© BBC 2017