Integration tests predicate on source version check

[dichn]

No description provided.

[rohanpm]

In my opinion, it's not implemented in a good way:

• every test is explicitly adding this check. If every test should do the check, then it should be implemented in one place where it works automatically for the tests, rather than requiring some duplicated code between each one.
• I don't think the tests should skip if the expected version is unset. It should just not do that check.

I earlier suggested doing it using a requests Adapter. This allows you to implement some logic around every request/response, so you could implement it once in one place and then know that every test is using it with no additional effort. Did you try that at all?

It would look something like the below. Note I just typed this directly into the comment here and haven't tested it at all.

@pytest.fixture
def requests_session(src_version):
  session = requests.Session()
  if src_version:
    # we have an expected version, mount an adapter which
    # will check for that version
    session.mount('https://', VersionCheckingAdapter(src_version))
  return session

class VersionCheckingAdapter(requests.adapters.HTTPAdapter):
   def __init__(self, expected_version):
        self.__expected_version = expected_version
        super().__init__()

   def send(self, request, *args, **kwargs):
      # always ask for the version
      request.headers["X-Exodus-Query"] = "1"
      # let superclass send the request
      response = super().send(request, *args, **kwargs)
      # check version in response
      got_version = response.headers["X-Exodus-Version"]
      # or just check the revision part, whatever
      if got_version != self.__expected_version:
          raise AssertionError("Expected to run against version %s but server sent X-Exodus-Version: %s" % (self.__expected_version, got_version))
      return response

def test_something(requests_session):
    # by using requests_session rather than requests.Session(),
    # I'm automatically getting the version check
    requests_session.get(...)

[rohanpm]

Minor: this could do with a comment or doc string. The meaning is not obvious.

[rohanpm]

It still shouldn't be skipping if the version is unknown.

[dichn]

update:

1. add comments for fixture: src_version
2. when src_version is unknown, the version check will be skipped