Merge ~roadmr/canonical-identity-provider:rename-vcs-header into canonical-identity-provider:master

[Daniel Manrique]

Rename the revision header to x-vcs-header to make it vcs-agnostic (no more bzr assumption)

QA:

curl --head https://login.staging.ubuntu.com | grep X-Vcs-Revision || echo "it didn't work"

The header name will now match what other services (dashboard, api.snapcraft.io) use.

[Guillermo Gonzalez (verterok)]

+1

review: Approve

[Maximiliano Bertacchini (maxiberta)]

Good idea. Do note SCA returns "X-VCS-Revision", with upper "VCS".

review: Approve

[Daniel Manrique (roadmr)]

Interesting - so does api.snapcraft.io, so I'll adjust.

In practice though header names are mostly treated case-insensitively (the code that eats this in the spec looks at x-vcs-revision).

Thanks!

review: Approve

052df6a... by Daniel Manrique on 2020-04-21

fixed header name

[Maximiliano Bertacchini (maxiberta)]

+1

review: Approve

[Guillermo Gonzalez (verterok)]

right, headers are case-insensitive: https://tools.ietf.org/html/rfc7230#section-3.2

diff --git a/src/identityprovider/wsgi.py b/src/identityprovider/wsgi.py
index 88828bb..48d99b1 100644
--- a/src/identityprovider/wsgi.py
+++ b/src/identityprovider/wsgi.py
@@ -41,7 +41,7 @@ class OOPSWSGIHandler(oops_wsgi_django.OOPSWSGIHandler):
 
 
 class BzrRevnoMiddleware(object):
-    REVNO_HEADER = ('X-Bzr-Revision-Number', version_info['revno'])
+    REVNO_HEADER = ('X-VCS-Revision', version_info['revno'])
 
     def __init__(self, app):
         self.app = app