Issue 4814 - Adds csv log to formmail2

sitescripts/formmail/test/test_formmail2.py

 # This file is part of the Adblock Plus web scripts,
 # 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/>.
+import os
+
 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']

[Vasily Kuznetsov, 2017/02/08 18:16:17]

As discussed over TS, let's override the csv_log with a temporary path here.

[Jon Sonesen, 2017/02/10 13:57:00]

Done.

 
 
 @pytest.fixture()
 def form_handler(form_config):
     return formmail2.make_handler('test', form_config)[1]
 
 
+@pytest.fixture()
+def log_path(form_config, tmpdir_factory):
+    log_file = form_config['csv_log'].value
+    log = tmpdir_factory.mktemp(log_file).join(log_file)
+    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'
+        'non_mandatory_email': 'test@test.com',
     }
 
 
 @pytest.fixture()
-def response_for(form_handler):
+def response_for(form_handler, log_path, monkeypatch):
+    # override the configured test.csv path
+    monkeypatch.chdir(os.path.dirname(log_path))

[Vasily Kuznetsov, 2017/02/08 18:16:17]

As discussed over TS, we won't need this if override the `log_path` in
`form_config`.

[Jon Sonesen, 2017/02/10 13:56:59]

Done.

     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))
@@ skipping 42 matching lines @@
     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('test', 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('test', 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('test', 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())
+
+

[Vasily Kuznetsov, 2017/02/08 18:16:16]

We should also have a test for the situation when the configuration changes and
the field list is not the same as in the log file. Then it should give an error
and write to a temp file next to the log.

It could be tricky to set this up, but I think if you just modify `form_config`
to change the list of fields and then give it to `formmail2.make_handler` to
make another handler, it will work. Since we don't need to reuse this modified
config and handler they don't need to be fixtures, we just do it inside this one
test.

[Jon Sonesen, 2017/02/10 13:57:00]

Great

+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('test', form_data, log_path)
+    form_data['email'] = 'test@foo.com'
+    formmail2.collect_formdata('test', 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']