Issue 4814 - Adds csv log to formmail2

sitescripts/formmail/test/test_formmail2.py.orig

+# This file is part of the Adblock Plus web scripts,

[Sebastian Noack, 2017/02/14 09:54:14]

It seems this file has been added by accident.

[Jon Sonesen, 2017/02/20 09:55:16]

Acknowledged.

+# Copyright (C) 2006-2016 Eyeo GmbH
+#
+# Adblock Plus is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# Adblock Plus 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+
+from urllib import urlencode
+from urllib2 import urlopen, HTTPError
+
+import pytest
+import datetime
+from wsgi_intercept import (urllib_intercept, add_wsgi_intercept,
+                            remove_wsgi_intercept)
+from csv import DictReader
+from sitescripts.formmail.web import formmail2
+
+
+@pytest.fixture()
+def form_config():
+    return formmail2.conf_parse(formmail2.get_config_items())['test']
+
+
+@pytest.fixture()
+def form_handler(form_config, log_path):
+    # override configured path to log file with tmpdir path
+    form_config['csv_log'].value = log_path
+    return formmail2.make_handler('test', form_config)[1]
+
+
+@pytest.fixture()
+def log_path(form_config, tmpdir):
+    log = tmpdir.mkdir('logs').join('test.csv_log')
+    return str(log)
+
+
+# We make this a fixture instead of a constant so we can modify it in each
+# test as needed without affecting other tests.
+@pytest.fixture
+def form_data():
+    return {
+        'email': 'john_doe@gmail.com',
+        'mandatory': 'john_doe@gmail.com',
+        'non_mandatory_message': 'Once upon a time\nthere lived a king.',
+        'non_mandatory_email': 'test@test.com',
+    }
+
+
+@pytest.fixture()
+def response_for(form_handler, log_path):
+    host, port = 'test.local', 80
+    urllib_intercept.install_opener()
+    add_wsgi_intercept(host, port, lambda: form_handler)
+    url = 'http://{}:{}'.format(host, port)
+
+    def response_for(data):
+        if data is None:
+            response = urlopen(url)
+        else:
+            response = urlopen(url, urlencode(data))
+        return response.code, response.read()
+
+    yield response_for
+    remove_wsgi_intercept()
+
+
+def test_config_parse(form_config):
+    assert form_config['url'].value == 'test/apply/submit'
+    assert form_config['fields']['email'].value == 'mandatory, email'
+
+
+def test_success(response_for, form_data, mocker):
+    sm_mock = mocker.patch('sitescripts.formmail.web.formmail2.sendMail')
+    assert response_for(form_data) == (200, '')
+    assert sm_mock.call_count == 1
+    params = sm_mock.call_args[0][1]['fields']
+    assert set(params.keys()) == set(form_data.keys())
+    for key, value in form_data.items():
+        assert params[key] == value
+
+
+def test_non_mandatory_no_msg(response_for, form_data, mocker):
+    mocker.patch('sitescripts.formmail.web.formmail2.sendMail')
+    form_data['non_mandatory'] = ''
+    assert response_for(form_data) == (200, '')
+
+
+def test_invalid_email_cstm_msg(response_for, form_data, mocker, form_config):
+    mocker.patch('sitescripts.formmail.web.formmail2.sendMail')
+    form_data['email'] = 'bademail'
+    with pytest.raises(HTTPError) as error:
+        response_for(form_data)
+    assert error.value.read() == 'You failed the email validation'
+
+
+def test_valid_nan_mandatory_email(response_for, form_data, mocker):
+    mocker.patch('sitescripts.formmail.web.formmail2.sendMail')
+    form_data['non_mandatory_email'] = 'asfaf'
+    with pytest.raises(HTTPError) as error:
+        response_for(form_data)
+    assert error.value.read() == 'Invalid email'
+
+    del form_data['non_mandatory_email']
+    assert response_for(form_data) == (200, '')
+
+
+def test_mandatory_fail_dflt_msg(response_for, form_data, mocker):
+    mocker.patch('sitescripts.formmail.web.formmail2.sendMail')
+    del form_data['mandatory']
+    with pytest.raises(HTTPError) as error:
+        response_for(form_data)
+    assert error.value.read() == 'No mandatory entered'
+
+
+def test_collect_with_tmpl(log_path, form_data):
+    form_data['time'] = 'test'
+    formmail2.collect_formdata(form_data, log_path)
+    with open(log_path) as csvfile:
+        reader = DictReader(csvfile)
+        row = reader.next()
+        assert row == form_data
+
+
+def test_collect_no_tmpl(log_path, form_data, form_config):
+    del(form_config['template'])
+    form_data['time'] = 'test'
+    formmail2.collect_formdata(form_data, log_path)
+    with open(log_path) as csvfile:
+        reader = DictReader(csvfile)
+        row = reader.next()
+        assert row == form_data
+
+
+def test_fieldnames(log_path, form_data):
+    form_data['time'] = str(datetime.datetime.now())
+    formmail2.collect_formdata(form_data, log_path)
+    with open(log_path) as csvfile:
+        reader = DictReader(csvfile)
+        for field in reader.fieldnames:
+            assert field in tuple(form_data.keys())
+
+
+def test_field_err(form_config, form_data, log_path):
+    """
+    Submits a form that does not have the dame fields as previous submissions
+    that have the same form name, asserts that proper message is returned and
+    the row was properly written
+    """
+    formmail2.collect_formdata(form_data, log_path)
+    del(form_config['fields']['email'])
+    del(form_data['email'])
+    try:
+        formmail2.collect_formdata(form_data, log_path)
+    except Exception as e:
+        assert e.message == \
+                'Field names have changed, error log written to {}'\
+                .format(log_path + '_error')
+
+    with open(log_path+'_error') as error_log:
+        reader = DictReader(error_log)
+        assert reader.next() == form_data
+
+
+def test_append_field_err(form_config, form_data, log_path):
+    """
+    Submits two identical forms that do not match the previous fields
+    found in the log file, triggering two rows to be added to the error
+    log and asserting the proper message is returned and that the rows
+    were written as expected
+    """
+    formmail2.collect_formdata(form_data, log_path)
+    del(form_config['fields']['email'])
+    del(form_data['email'])
+    try:
+        formmail2.collect_formdata(form_data, log_path)
+    except Exception as e:
+        pass
+    try:
+        formmail2.collect_formdata(form_data, log_path)
+    except Exception as e:
+        assert e.message == \
+                'Field names have changed, error log appended to {}'\
+                .format(log_path + '_error')
+
+    with open(log_path+'_error') as error_log:
+        reader = DictReader(error_log)
+        # two identical rows should be in the rror log
+        assert reader.next() == form_data
+        assert reader.next() == form_data
+
+
+def test_append_log(form_data, log_path):
+    """
+    collect data twice, altering a field in the second call
+    assert that the 2nd row is equal to the resulting form data
+    """
+    form_data['time'] = str(datetime.datetime.now())
+    formmail2.collect_formdata(form_data, log_path)
+    form_data['email'] = 'test@foo.com'
+    formmail2.collect_formdata(form_data, log_path)
+    with open(log_path) as csvfile:
+        reader = DictReader(csvfile, fieldnames=form_data.keys())
+        # header
+        reader.next()
+        row1 = reader.next()
+        row2 = reader.next()
+
+        assert row2['email'] == form_data['email']
+        assert row2['email'] != row1['email']