Issue #5352 - generate_static_pages cannot deal with directories being turned into regular pages

tests/test_generation_exceptional_cases.py

Index: tests/test_generation_exceptional_cases.py
diff --git a/tests/test_generation_exceptional_cases.py b/tests/test_generation_exceptional_cases.py
new file mode 100644
index 0000000000000000000000000000000000000000..59846ca527964ac82d283383cd12a91e7f3950f9
--- /dev/null
+++ b/tests/test_generation_exceptional_cases.py
@@ -0,0 +1,84 @@
+# This file is part of the Adblock Plus web scripts,
+# Copyright (C) 2006-present 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
+
+import pytest
+
+
+@pytest.fixture
+def target_dir_with_file(tmpdir):
+    target_dir = tmpdir.mkdir('out_file').strpath
+    os.mkdir(os.path.join(target_dir, 'en'))
+
+    with open(os.path.join(target_dir, 'en', 'foo'), 'w') as f:
+        f.write('test\n')
+
+    yield target_dir
+
+
+@pytest.fixture
+def target_dir_with_dir(tmpdir):
+    target_dir = tmpdir.mkdir('out_dir').strpath
+    os.makedirs(os.path.join(target_dir, 'en', 'translate'))
+
+    yield target_dir
+
+
+@pytest.fixture
+def target_dir_with_fifo(tmpdir):
+    target_dir = tmpdir.mkdir('out_dir').strpath
+    os.mkdir(os.path.join(target_dir, 'en'))
+    os.mkfifo(os.path.join(target_dir, 'en', 'translate'))
+
+    yield target_dir
+
+
+@pytest.mark.script_launch_mode('subprocess')

[Vasily Kuznetsov, 2018/09/27 11:05:07]

As we've discussed, please try to convert these generation tests to import the
right function from generate_static_pages.py and run it in the same process.
Doing these subprocess calls slows down the tests and we don't really need it to
tests directory/file handling.

[Tudor Avram, 2018/10/04 06:34:18]

Done for first two tests. The last one requires some extra mocking that might
break things. (see below).

+def test_generate_dir_instead_of_file(temp_site, target_dir_with_file,
+                                      script_runner):
+    cmd = ['python', '-m', 'cms.bin.generate_static_pages', str(temp_site),
+           str(target_dir_with_file)]
+
+    script_runner.run(*cmd)
+
+    assert os.path.isdir(os.path.join(target_dir_with_file, 'en', 'foo'))
+
+
+@pytest.mark.script_launch_mode('subprocess')
+def test_generate_file_instead_of_dir(temp_site, target_dir_with_dir,
+                                      script_runner):
+    cmd = ['python', '-m', 'cms.bin.generate_static_pages', str(temp_site),
+           str(target_dir_with_dir)]
+
+    script_runner.run(*cmd)
+
+    print(os.listdir(target_dir_with_dir))
+
+    assert os.path.isfile(os.path.join(target_dir_with_dir, 'en', 'translate'))
+
+
+@pytest.mark.script_launch_mode('subprocess')
+def test_generate_fifo_instead_of_file(temp_site, target_dir_with_fifo,
+                                       script_runner):

[Tudor Avram, 2018/10/04 06:34:18]

For this last test, I would have to mock sys.exit() and that might break a
couple of things in there (as in the function would continue to run, even though
it was supposed to stop. This breaks some things along the way. 

[Vasily Kuznetsov, 2018/10/05 09:40:43]

You can catch SystemExit exception in this test. Check this out:

    >>> try:
    ...     import sys
    ...     sys.exit('boom')
    ... except SystemExit as exit:
    ...     pass
    ...
    >>> exit
    SystemExit('boom',)

+    cmd = ['python', '-m', 'cms.bin.generate_static_pages', str(temp_site),
+           str(target_dir_with_fifo)]
+
+    ret = script_runner.run(*cmd)
+
+    print(ret.stderr)
+
+    assert not ret.success
+    assert 'It is neither a file, nor a directory!' in ret.stderr