conditions.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
 
"""
Script to make sure the conditions database interface is behaving as expected.
 
We do this by creating a local http server which acts as a mock database for
getting the payload information and payloads and then we run through different scenarios:
    - unknown host
    - connection refused
    - url not found (404)
    - retry on (503)
    - corrupt payload information
    - incomplete payload information
    - correct payload information
    - payload file missing
    - payload file checksum mismatch
"""
 
import sys
import os
import basf2
from http.server import HTTPServer, BaseHTTPRequestHandler
from urllib.parse import urlparse, parse_qs
from b2test_utils import clean_working_directory, safe_process, skip_test, configure_logging_for_tests
import multiprocessing
import shutil
 
 
class SimpleConditionsDB(BaseHTTPRequestHandler):
    """Simple ConditionsDB server which handles just the two things needed to
    test the interface: get a list of payloads for the current run and download
    a payloadfile. It will return different payloads for the experiments to
    check for different error conditions"""
 
    
    globaltag_states = """[
      { "name": "OPEN" },
      { "name": "TESTING" },
      { "name": "VALIDATED" },
      { "name": "PUBLISHED" },
      { "name": "RUNNING" },
      { "name": "INVALID" }
    ]"""
 
    
    example_payload = """[{{
        "payload": {{
            "baseUrl": "%(baseurl)s",
            "payloadId":1,
            "checksum":"{checksum}",
            "revision":{revision},
            "payloadUrl":"dbstore_BeamParameters_rev_{revision}.root",
            "basf2Module": {{ "name":"BeamParameters", "basf2Package": {{ "name":"dbstore" }} }}
        }}, "payloadIov": {{
            "expStart": %(exp)s,
            "expEnd": %(exp)s,
            "runStart": %(run)s,
            "runEnd": %(run)s
        }}
        }}]"""
 
    
    payloads = {
        # let's start with empty information
        "0": "[]",
        # or one child but the wrong one
        "1": '[{ "foo": { } }]',
        # or let's have some invalid XML
        "2": '[{ "foo',
        # let's provide one correct payload
        "3": example_payload.format(checksum="2447fbcf76419fbbc7c6d015ef507769", revision="1"),
        # same payload but checksum mismatch
        "4": example_payload.format(checksum="00[wrong checksum]", revision="1"),
        # non existing payload file
        "5": example_payload.format(checksum="00[missing]", revision="2"),
        # duplicate payload, or in this case triple
        "6": example_payload.format(checksum="2447fbcf76419fbbc7c6d015ef507769", revision="2")[:-1] + "," +
             example_payload.format(checksum="2447fbcf76419fbbc7c6d015ef507769", revision="1")[1:-1] + "," +
             example_payload.format(checksum="2447fbcf76419fbbc7c6d015ef507769", revision="3")[1:],
    }
 
    
    globaltags = {
        "localtest": "PUBLISHED",
        "newgt": "NEW",
        "invalidgt": "INVALID",
    }
 
    def reply(self, xml):
        """Return a given xml string"""
        self.send_response(200)
        self.end_headers()
        self.wfile.write(xml.encode())
 
    def log_message(self, format, *args):
        """Override default logging to remove timestamp"""
        print("MockConditionsDB:", format % args)
 
    def log_error(self, *args):
        """Disable error logs"""
        pass
 
    def do_GET(self):
        """Parse a get request"""
        url = urlparse(self.path)
        params = parse_qs(url.query)
        if url.path == "/v2/globalTagStatus":
            return self.reply(self.globaltag_states)
        # return mock payload info
        elif url.path.startswith("/v2/globalTag"):
            # gt info
            gtname = url.path.split("/")[-1]
            if gtname in self.globaltags:
                return self.reply('{ "name": "%s", "globalTagStatus": { "name": "%s" } }' % (gtname, self.globaltags[gtname]))
            else:
                return self.send_error(404)
 
        if url.path.endswith("/iovPayloads/"):
            exp = params["expNumber"][0]
            run = params["runNumber"][0]
 
            if int(exp) > 100:
                self.send_error(int(exp))
                return
 
            if int(run) > 1:
                exp = None
 
            if exp in self.payloads:
                baseurl = "http://%s:%s" % self.server.socket.getsockname()
                return self.reply(self.payloads[exp] % dict(exp=exp, run=run, baseurl=baseurl))
        else:
            # check if a fallback payload file exists in the conditions_testpayloads directory
            filename = os.path.basename(url.path)
            # replace rev_3 with rev_1
            filename = filename.replace("rev_3", "rev_1")
            basedir = basf2.find_file("framework/tests/conditions_testpayloads")
            path = os.path.join(basedir, filename)
            if os.path.isfile(path):
                # ok, file exists. let's serve it
                self.send_response(200)
                self.end_headers()
                with open(path, "rb") as f:
                    shutil.copyfileobj(f, self.wfile)
                return
 
        # fall back: just return file not found
        self.send_error(404)
 
 
def run_mockdb(pipe):
    """Startup the mock conditions db server and send the port we listen on back
    to the parent process"""
    # listen on port 0 means we want to listen on any free port which would be
    # nice. But since the new code prints the full url including port when there
    # is a problem we choose a fixed one and hope that it it's free ...
    try:
        httpd = HTTPServer(("127.0.0.1", 12701), SimpleConditionsDB)
    except OSError:
        pipe.send(None)
        skip_test("Socket 12701 is in use, cannot continue")
        return
    # so see which port we actually got
    port = httpd.socket.getsockname()[1]
    # and send to parent
    pipe.send(port)
    # now start listening
    httpd.serve_forever()
 
 
def run_redirect(pipe, redir_port):
    """Startup the redirection server: any request should be transparently forwarded
    to the other using 308 http replies"""
 
    class SimpleRedirectServer(BaseHTTPRequestHandler):
        def do_GET(self):
            self.send_response(308)
            self.send_header("Location", f"http://127.0.0.1:{redir_port}{self.path}")
            self.end_headers()
 
        def log_message(self, format, *args):
            """Override default logging to remove timestamp"""
            print("Redirect Server:", format % args)
 
        def log_error(self, *args):
            """Disable error logs"""
            pass
 
    try:
        httpd = HTTPServer(("127.0.0.1", 12702), SimpleRedirectServer)
        pipe.send(12702)
    except OSError:
        pipe.send(None)
        skip_test("Socket 12702 is in use, cannot continue")
        return
 
    # now start listening
    httpd.serve_forever()
 
 
def dbprocess(host, path, lastChangeCallback=lambda: None, *, globaltag="localtest"):
    """Process a given path in a child process so that FATAL will not abort this
    script but just the child and configure to use a central database at the given host"""
    # reset the database so that there is no chain
    basf2.reset_database()
    # now run the path in a child process inside of a clean working directory
    with clean_working_directory():
        # make logging more reproducible by replacing some strings
        configure_logging_for_tests()
        basf2.logging.log_level = basf2.LogLevel.DEBUG
        basf2.logging.debug_level = 30
        basf2.conditions.reset()
        basf2.conditions.expert_settings(download_cache_location="db-cache")
        basf2.conditions.override_globaltags([globaltag])
        if host:
            basf2.conditions.metadata_providers = [host]
        basf2.conditions.payload_locations = []
        lastChangeCallback()
        safe_process(path)
 
 
# keep timeouts short for testing
basf2.conditions.expert_settings(backoff_factor=1, connection_timeout=5,
                                 stalled_timeout=5, max_retries=3)
 
# set the random seed to something fixed
basf2.set_random_seed("something important")
# and create a pipe so we can send the port we listen on from child to parent
conn = multiprocessing.Pipe(False)
# now start the mock conditions database as daemon so it gets killed at the end
# of the script
mock_conditionsdb = multiprocessing.Process(target=run_mockdb, args=(conn[1],))
mock_conditionsdb.daemon = True
mock_conditionsdb.start()
# mock db has started when we recieve the port number from the child, so wait for that
mock_port = conn[0].recv()
# if the port we got is None the server didn't start ... so bail
if mock_port is None:
    sys.exit(1)
 
# startup redirect server, same as conditionsdb_
redir_server = multiprocessing.Process(target=run_redirect, args=(conn[1], mock_port))
redir_server.daemon = True
redir_server.start()
redir_port = conn[0].recv()
if redir_port is None:
    sys.exit(1)
 
# and remember host for database access
mock_host = f"http://localhost:{mock_port}/"
redir_host = f"http://localhost:{redir_port}/"
 
# create a simple processing path with just event info setter an a module which
# prints the beamparameters from the database
main = basf2.Path()
evtinfo = main.add_module("EventInfoSetter")
main.add_module("PrintBeamParameters")
 
# run trough a set of experiments, each time we want to process two runs to make
# sure that it works correctly for more than one run
for exp in range(len(SimpleConditionsDB.payloads) + 1):
    try:
        basf2.B2INFO(f">>> check exp {exp}: {SimpleConditionsDB.payloads[str(exp)][0:20]}...)")
    except KeyError:
        basf2.B2INFO(f">>> check exp {exp}")
    evtinfo.param({"expList": [exp, exp, exp], "runList": [0, 1, 2], "evtNumList": [1, 1, 1]})
    dbprocess(mock_host, main)
    # and again using redirection
    dbprocess(redir_host, main)
 
basf2.B2INFO(">>> check that a invalid global tag or a misspelled global tag actually throw errors")
evtinfo.param({"expList": [3], "runList": [0], "evtNumList": [1]})
for gt in ["newgt", "invalidgt", "horriblymisspelled",
           "h͌̉e̳̞̞͆ͨ̏͋̕ ͍͚̱̰̀͡c͟o͛҉̟̰̫͔̟̪̠m̴̀ͯ̿͌ͨ̃͆e̡̦̦͖̳͉̗ͨͬ̑͌̃ͅt̰̝͈͚͍̳͇͌h̭̜̙̦̣̓̌̃̓̀̉͜!̱̞̻̈̿̒̀͢!̋̽̍̈͐ͫ͏̠̹̺̜̬͍ͅ"]:
    dbprocess(mock_host, main, globaltag=gt)
 
basf2.B2INFO(">>> check retry on 503 errors")
evtinfo.param({"expList": [503], "runList": [0], "evtNumList": [1]})
dbprocess(mock_host, main)
basf2.B2INFO(">>> check again without retries")
basf2.conditions.expert_settings(max_retries=0)
dbprocess(mock_host, main)
 
# the following ones fail, no need for 3 times
evtinfo.param({"expList": [0], "runList": [0], "evtNumList": [1]})
 
basf2.B2INFO(">>> try to open localhost on port 0, this should always be refused")
dbprocess("http://localhost:0", main)
 
basf2.B2INFO(">>> and once more with a non existing host name to check for lookup errors")
dbprocess("http://nosuchurl/", main)
 
basf2.B2INFO(">>> and once more with a non existing protocol")
dbprocess("nosuchproto://nosuchurl/", main)
 
basf2.B2INFO(">>> and once more with a totally bogus url")
dbprocess("h͌̉e̳̞̞͆ͨ̏͋̕ ͍͚̱̰̀͡c͟o͛҉̟̰̫͔̟̪̠m̴̀ͯ̿͌ͨ̃͆e̡̦̦͖̳͉̗ͨͬ̑͌̃ͅt̰̝͈͚͍̳͇͌h̭̜̙̦̣̓̌̃̓̀̉͜!̱̞̻̈̿̒̀͢!̋̽̍̈͐ͫ͏̠̹̺̜̬͍ͅ", main)
 
basf2.B2INFO(""">>> try to have a list of servers from environment variable
    We expect that it fails over to the third server, {mock_host}, but then succeeds
""")
evtinfo.param({"expList": [3], "runList": [0], "evtNumList": [1]})
serverlist = [
    "http://localhost:0",
    "http://h͌̉e̳̞̞͆ͨ̏͋̕c͟o͛҉̟̰̫͔̟̪̠m̴̀ͯ̿͌ͨ̃͆e̡̦̦͖̳͉̗ͨͬ̑͌̃ͅt̰̝͈͚͍̳͇͌h̭̜̙̦̣̓̌̃̓̀̉͜!̱̞̻̈̿̒̀͢",
    mock_host
]
os.environ["BELLE2_CONDB_SERVERLIST"] = " ".join(serverlist)
dbprocess("", main)
 
# ok, try again with the steering file settings instead of environment variable
basf2.B2INFO(""">>> try to have a list of servers from steering file
    We expect that it fails over to the third server, {mock_host}, but then succeeds
""")
dbprocess("", main, lastChangeCallback=lambda: basf2.set_central_serverlist(serverlist))
 
if "ssl" in sys.argv:
    # ok, test SSL connectivity ... for now we just want to accept anything. This
    # is disabled by default since I don't want to depend on badssl.com to be
    # available
    for hostname in ("expired", "wrong.host", "self-signed", "untrusted-root"):
        dbprocess(f"https://{hostname}.badssl.com/", main)