Tests for mediagoblin.config functions

Tests for:
  - read_mediagoblin_config()
  - generate_validation_report()

diff --git a/mediagoblin/tests/fake_carrot_conf_bad.ini b/mediagoblin/tests/fake_carrot_conf_bad.ini
new file mode 100644 (file)
index 0000000..0c79b35
--- /dev/null
+++ b/mediagoblin/tests/fake_carrot_conf_bad.ini
@@ -0,0 +1,14 @@
+[carrotapp]
+# Whether or not our carrots are going to be turned into cake.
+## These should throw errors
+carrotcake = slobber
+num_carrots = GROSS
+
+# A message encouraging our users to eat their carrots.
+encouragement_phrase = 586956856856 # shouldn't throw error
+
+# Something extra!
+blah_blah = "blah!" # shouldn't throw error either
+
+[celery]
+eat_celery_with_carrots = pants # yeah that's def an error right there.

diff --git a/mediagoblin/tests/fake_carrot_conf_empty.ini b/mediagoblin/tests/fake_carrot_conf_empty.ini
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/mediagoblin/tests/fake_carrot_conf_good.ini b/mediagoblin/tests/fake_carrot_conf_good.ini
new file mode 100644 (file)
index 0000000..fed14d0
--- /dev/null
+++ b/mediagoblin/tests/fake_carrot_conf_good.ini
@@ -0,0 +1,13 @@
+[carrotapp]
+# Whether or not our carrots are going to be turned into cake.
+carrotcake = true
+num_carrots = 88
+
+# A message encouraging our users to eat their carrots.
+encouragement_phrase = "I'd love it if you eat your carrots!"
+
+# Something extra!
+blah_blah = "blah!"
+
+[celery]
+eat_celery_with_carrots = False

diff --git a/mediagoblin/tests/fake_config_spec.ini b/mediagoblin/tests/fake_config_spec.ini
new file mode 100644 (file)
index 0000000..9421ce3
--- /dev/null
+++ b/mediagoblin/tests/fake_config_spec.ini
@@ -0,0 +1,10 @@
+[carrotapp]
+# Whether or not our carrots are going to be turned into cake.
+carrotcake = boolean(default=False)
+num_carrots = integer(default=1)
+
+# A message encouraging our users to eat their carrots.
+encouragement_phrase = string()
+
+[celery]
+eat_celery_with_carrots = boolean(default=True)
\ No newline at end of file

diff --git a/mediagoblin/tests/test_config.py b/mediagoblin/tests/test_config.py
new file mode 100644 (file)
index 0000000..244f05e
--- /dev/null
+++ b/mediagoblin/tests/test_config.py
@@ -0,0 +1,97 @@
+# GNU MediaGoblin -- federated, autonomous media hosting
+# Copyright (C) 2011 Free Software Foundation, Inc
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import pkg_resources
+
+from mediagoblin import config
+
+
+CARROT_CONF_GOOD = pkg_resources.resource_filename(
+    'mediagoblin.tests', 'fake_carrot_conf_good.ini')
+CARROT_CONF_EMPTY = pkg_resources.resource_filename(
+    'mediagoblin.tests', 'fake_carrot_conf_empty.ini')
+CARROT_CONF_BAD = pkg_resources.resource_filename(
+    'mediagoblin.tests', 'fake_carrot_conf_bad.ini')
+FAKE_CONFIG_SPEC = pkg_resources.resource_filename(
+    'mediagoblin.tests', 'fake_config_spec.ini')
+
+
+def test_read_mediagoblin_config():
+    # An empty file
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_EMPTY, FAKE_CONFIG_SPEC)
+
+    assert this_conf['carrotapp']['carrotcake'] == False
+    assert this_conf['carrotapp']['num_carrots'] == 1
+    assert not this_conf['carrotapp'].has_key('encouragement_phrase')
+    assert this_conf['celery']['eat_celery_with_carrots'] == True
+
+    # A good file
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_GOOD, FAKE_CONFIG_SPEC)
+
+    assert this_conf['carrotapp']['carrotcake'] == True
+    assert this_conf['carrotapp']['num_carrots'] == 88
+    assert this_conf['carrotapp']['encouragement_phrase'] == \
+        "I'd love it if you eat your carrots!"
+    assert this_conf['carrotapp']['blah_blah'] == "blah!"
+    assert this_conf['celery']['eat_celery_with_carrots'] == False
+
+    # A bad file
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_BAD, FAKE_CONFIG_SPEC)
+
+    # These should still open but will have errors that we'll test for
+    # in test_generate_validation_report()
+    assert this_conf['carrotapp']['carrotcake'] == 'slobber'
+    assert this_conf['carrotapp']['num_carrots'] == 'GROSS'
+    assert this_conf['carrotapp']['encouragement_phrase'] == \
+        "586956856856"
+    assert this_conf['carrotapp']['blah_blah'] == "blah!"
+    assert this_conf['celery']['eat_celery_with_carrots'] == "pants"
+
+
+def test_generate_validation_report():
+    # Empty
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_EMPTY, FAKE_CONFIG_SPEC)
+    report = config.generate_validation_report(this_conf, validation_results)
+    assert report is None
+
+    # Good
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_GOOD, FAKE_CONFIG_SPEC)
+    report = config.generate_validation_report(this_conf, validation_results)
+    assert report is None
+
+    # Bad
+    this_conf, validation_results = config.read_mediagoblin_config(
+        CARROT_CONF_BAD, FAKE_CONFIG_SPEC)
+    report = config.generate_validation_report(this_conf, validation_results)
+
+    assert report.startswith("""\
+There were validation problems loading this config file:
+--------------------------------------------------------""")
+
+    expected_warnings = [
+        'carrotapp:carrotcake = the value "slobber" is of the wrong type.',
+        'carrotapp:num_carrots = the value "GROSS" is of the wrong type.',
+        'celery:eat_celery_with_carrots = the value "pants" is of the wrong type.']
+    warnings = report.splitlines()[2:]
+
+    assert len(warnings) == 3
+    for warning in expected_warnings:
+        assert warning in warnings