Whitelist change process

Development

To smooth the bumps out of this process for the future, we propose the following workflow / interactions between yourselves (client developers) and us (the MDS development team). 

The diagram above is part of a traditional development workflow. Each phase can be simply summarized.

• Develop
  Queries are developed against an MDS in a lab running in "GOD_MODE" with no extra enforcement applied. If the lab is not set up this way, direct your administrator to the Configuration Scenarios page to open it up for you. This should allow for exploratory development.

• Define
  When development is complete, please define the queries that will be run against MDS that have been added and/or modified.

• Request
  Send the set of new queries to us using one of the methods below. Please don't think of this step as some unwanted drudgery, but as any other API tweak required of any other module.

• Release
  Release your code,  We will make the changes our side too and everything should hopefully slot together nicely in systest/solval.

Notifying API changes

Consumer-driven contracts

The PACT contract testing tool is the preferred way to ensure the contract between your client and our deployment. Contract testing ensures that services (such as an API provider and a client) can communicate with each other. Without contract testing, the only way to know that services can communicate is by using expensive and brittle integration tests. The benefits of using PACT include:

• NAGRA are notified automatically of any changes (by our build failing).
• If the test passes, NAGRA can be completely sure that your needs have been met.
• We cannot accidentally break your client, because our build will not work if we do!

JIRA ticket

Alternatively, developers can raise a CR to make the query amendments. Please log a ticket within the OpenTV Platform (OPF) project, against metadataserver, and assign to at least one member of the Kodiak team. To do this as efficiently as possible, please provide clear examples of the query that you are running.

Post-deployment configuration

This should be an emergency measure only - any queries known in advance should be added via one of the above two options.

The environment can be configured post-deployment, but it should be avoided if possible as it can be a painstaking and fairly error-prone process. For details of how to do this safely, see the Configuration Scenarios page.