Merge pull request #763 from alphagov/cloudfoundry

Run on Paas

tests/app/test_cloudfoundry_config.py

@@ -0,0 +1,167 @@
+import os
+import json
+
+import pytest
+
+from app.cloudfoundry_config import extract_cloudfoundry_config, set_config_env_vars
+
+
+@pytest.fixture
+def notify_config():
+    return {
+        'name': 'notify-config',
+        'credentials': {
+            'admin_base_url': 'admin base url',
+            'api_host_name': 'api host name',
+            'admin_client_secret': 'admin client secret',
+            'secret_key': 'secret key',
+            'dangerous_salt': 'dangerous salt',
+        }
+    }
+
+
+@pytest.fixture
+def aws_config():
+    return {
+        'name': 'notify-aws',
+        'credentials': {
+            'sqs_queue_prefix': 'sqs queue prefix',
+            'aws_access_key_id': 'aws access key id',
+            'aws_secret_access_key': 'aws secret access key',
+        }
+    }
+
+
+@pytest.fixture
+def hosted_graphite_config():
+    return {
+        'name': 'hosted-graphite',
+        'credentials': {
+            'statsd_prefix': 'statsd prefix'
+        }
+    }
+
+
+@pytest.fixture
+def mmg_config():
+    return {
+        'name': 'mmg',
+        'credentials': {
+            'api_url': 'mmg api url',
+            'api_key': 'mmg api key'
+        }
+    }
+
+
+@pytest.fixture
+def firetext_config():
+    return {
+        'name': 'firetext',
+        'credentials': {
+            'api_key': 'firetext api key',
+            'loadtesting_api_key': 'loadtesting api key'
+        }
+    }
+
+
+@pytest.fixture
+def postgres_config():
+    return [
+        {
+            'credentials': {
+                'uri': 'postgres uri'
+            }
+        }
+    ]
+
+
+@pytest.fixture
+def cloudfoundry_config(
+        postgres_config,
+        notify_config,
+        aws_config,
+        hosted_graphite_config,
+        mmg_config,
+        firetext_config
+):
+    return {
+        'postgres': postgres_config,
+        'user-provided': [
+            notify_config,
+            aws_config,
+            hosted_graphite_config,
+            mmg_config,
+            firetext_config
+        ]
+    }
+
+
+@pytest.fixture
+def cloudfoundry_environ(monkeypatch, cloudfoundry_config):
+    monkeypatch.setenv('VCAP_SERVICES', json.dumps(cloudfoundry_config))
+    monkeypatch.setenv('VCAP_APPLICATION', '{"space_name": "🚀🌌"}')
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_extract_cloudfoundry_config_populates_other_vars():
+    extract_cloudfoundry_config()
+
+    assert os.environ['SQLALCHEMY_DATABASE_URI'] == 'postgres uri'
+    assert os.environ['LOGGING_STDOUT_JSON'] == '1'
+    assert os.environ['NOTIFY_ENVIRONMENT'] == '🚀🌌'
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_set_config_env_vars_ignores_unknown_configs(cloudfoundry_config):
+    cloudfoundry_config['foo'] = {'credentials': {'foo': 'foo'}}
+    cloudfoundry_config['user-provided'].append({
+        'name': 'bar', 'credentials': {'bar': 'bar'}
+    })
+
+    set_config_env_vars(cloudfoundry_config)
+
+    assert 'foo' not in os.environ
+    assert 'bar' not in os.environ
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_notify_config():
+    extract_cloudfoundry_config()
+
+    assert os.environ['ADMIN_BASE_URL'] == 'admin base url'
+    assert os.environ['API_HOST_NAME'] == 'api host name'
+    assert os.environ['ADMIN_CLIENT_SECRET'] == 'admin client secret'
+    assert os.environ['SECRET_KEY'] == 'secret key'
+    assert os.environ['DANGEROUS_SALT'] == 'dangerous salt'
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_aws_config():
+    extract_cloudfoundry_config()
+
+    assert os.environ['NOTIFICATION_QUEUE_PREFIX'] == 'sqs queue prefix'
+    assert os.environ['AWS_ACCESS_KEY_ID'] == 'aws access key id'
+    assert os.environ['AWS_SECRET_ACCESS_KEY'] == 'aws secret access key'
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_hosted_graphite_config():
+    extract_cloudfoundry_config()
+
+    assert os.environ['STATSD_PREFIX'] == 'statsd prefix'
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_mmg_config():
+    extract_cloudfoundry_config()
+
+    assert os.environ['MMG_URL'] == 'mmg api url'
+    assert os.environ['MMG_API_KEY'] == 'mmg api key'
+
+
+@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
+def test_firetext_config():
+    extract_cloudfoundry_config()
+
+    assert os.environ['FIRETEXT_API_KEY'] == 'firetext api key'
+    assert os.environ['LOADTESTING_API_KEY'] == 'loadtesting api key'

tests/app/test_config.py

@@ -0,0 +1,80 @@
+import os
+import importlib
+from unittest import mock
+
+import pytest
+
+from app import config
+
+
+def cf_conf():
+    os.environ['ADMIN_BASE_URL'] = 'cf'
+
+
+@pytest.fixture
+def reload_config():
+    """
+    Reset config, by simply re-running config.py from a fresh environment
+    """
+    old_env = os.environ.copy()
+
+    yield
+
+    os.environ = old_env
+    importlib.reload(config)
+
+
+def test_load_cloudfoundry_config_if_available(monkeypatch, reload_config):
+    os.environ['ADMIN_BASE_URL'] = 'env'
+    monkeypatch.setenv('VCAP_SERVICES', 'some json blob')
+    monkeypatch.setenv('VCAP_APPLICATION', 'some json blob')
+
+    with mock.patch('app.cloudfoundry_config.extract_cloudfoundry_config', side_effect=cf_conf) as cf_config:
+        # reload config so that its module level code (ie: all of it) is re-instantiated
+        importlib.reload(config)
+
+    assert cf_config.called
+
+    assert os.environ['ADMIN_BASE_URL'] == 'cf'
+    assert config.Config.ADMIN_BASE_URL == 'cf'
+
+
+def test_load_config_if_cloudfoundry_not_available(monkeypatch, reload_config):
+    os.environ['ADMIN_BASE_URL'] = 'env'
+
+    monkeypatch.delenv('VCAP_SERVICES', raising=False)
+
+    with mock.patch('app.cloudfoundry_config.extract_cloudfoundry_config') as cf_config:
+        # reload config so that its module level code (ie: all of it) is re-instantiated
+        importlib.reload(config)
+
+    assert not cf_config.called
+
+    assert os.environ['ADMIN_BASE_URL'] == 'env'
+    assert config.Config.ADMIN_BASE_URL == 'env'
+
+
+def test_cloudfoundry_config_has_different_defaults():
+    # these should always be set on Sandbox
+    assert config.Sandbox.REDIS_ENABLED is False
+
+
+def test_logging_stdout_json_defaults_to_off(reload_config):
+    os.environ.pop('LOGGING_STDOUT_JSON', None)
+    assert config.Config.LOGGING_STDOUT_JSON is False
+
+
+def test_logging_stdout_json_sets_to_off_if_not_recognised(reload_config):
+    os.environ['LOGGING_STDOUT_JSON'] = 'foo'
+
+    importlib.reload(config)
+
+    assert config.Config.LOGGING_STDOUT_JSON is False
+
+
+def test_logging_stdout_json_sets_to_on_if_set_to_1(reload_config):
+    os.environ['LOGGING_STDOUT_JSON'] = '1'
+
+    importlib.reload(config)
+
+    assert config.Config.LOGGING_STDOUT_JSON is True

tests/conftest.py

@@ -80,9 +80,16 @@ def notify_db_session(notify_db):
     notify_db.session.commit()
 
 
-@pytest.fixture(scope='function')
-def os_environ(mocker):
-    mocker.patch('os.environ', {})
+@pytest.fixture
+def os_environ():
+    """
+    clear os.environ, and restore it after the test runs
+    """
+    # for use whenever you expect code to edit environment variables
+    old_env = os.environ.copy()
+    os.environ = {}
+    yield
+    os.environ = old_env
 
 
 @pytest.fixture(scope='function')