cubicweb/devtools/test/unittest_devctl.py
author Denis Laxalde <denis.laxalde@logilab.fr>
Thu, 19 May 2016 14:27:28 +0200
changeset 11454 7770559e3945
parent 11427 7d38eb1bcd1f
child 11455 d686c4e8cdb2
permissions -rw-r--r--
[devtools] Update skeleton and newcube command to cube as package layout Related to #13001466.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
     1
# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     2
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     3
#
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     4
# This file is part of CubicWeb.
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     5
#
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     6
# CubicWeb is free software: you can redistribute it and/or modify it under the
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     7
# terms of the GNU Lesser General Public License as published by the Free
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     8
# Software Foundation, either version 2.1 of the License, or (at your option)
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
     9
# any later version.
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    10
#
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    13
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    14
# details.
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    15
#
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    16
# You should have received a copy of the GNU Lesser General Public License along
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    17
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    18
"""unit tests for cubicweb-ctl commands from devtools"""
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    19
11136
b14885133f90 [test] Make sure that newcube command test produces expected files
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11099
diff changeset
    20
import os
b14885133f90 [test] Make sure that newcube command test produces expected files
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11099
diff changeset
    21
import os.path as osp
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    22
import sys
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    23
import tempfile
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    24
import shutil
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    25
from subprocess import Popen, PIPE, STDOUT
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    26
from unittest import TestCase
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    27
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    28
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    29
def newcube(directory, name):
11422
63ac20ef558e [pkg] Properly export data files in setup.py and adjust "newcube" test
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11176
diff changeset
    30
    cmd = ['cubicweb-ctl', 'newcube', '--directory', directory, name]
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    31
    proc = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=STDOUT)
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    32
    stdout, _ = proc.communicate(b'short_desc\n')
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    33
    return proc.returncode, stdout
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    34
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    35
11427
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    36
def to_unicode(msg):
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    37
    return msg.decode(sys.getdefaultencoding(), errors='replace')
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    38
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    39
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    40
class DevCtlTC(TestCase):
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    41
    """Test case for devtools commands"""
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    42
11137
447a6f1e8def [test] fix unittest_devctl on python3.4
Julien Cristau <julien.cristau@logilab.fr>
parents: 11136
diff changeset
    43
    if not hasattr(TestCase, 'assertItemsEqual'):
447a6f1e8def [test] fix unittest_devctl on python3.4
Julien Cristau <julien.cristau@logilab.fr>
parents: 11136
diff changeset
    44
        assertItemsEqual = TestCase.assertCountEqual
447a6f1e8def [test] fix unittest_devctl on python3.4
Julien Cristau <julien.cristau@logilab.fr>
parents: 11136
diff changeset
    45
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    46
    def test_newcube(self):
11454
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    47
        expected_project_content = ['setup.py', 'test', 'MANIFEST.in',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    48
                                    'cubicweb_foo',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    49
                                    'cubicweb-foo.spec', 'debian', 'README',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    50
                                    'tox.ini']
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    51
        expected_package_content = ['i18n', 'hooks.py', 'views.py',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    52
                                    'migration', 'entities.py', 'schema.py',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    53
                                    '__init__.py', 'data', '__pkginfo__.py']
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    54
        tmpdir = tempfile.mkdtemp(prefix="temp-cwctl-newcube")
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    55
        try:
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    56
            retcode, stdout = newcube(tmpdir, 'foo')
11427
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    57
            self.assertEqual(retcode, 0, msg=to_unicode(stdout))
11454
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    58
            project_dir = osp.join(tmpdir, 'cubicweb-foo')
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    59
            project_content = os.listdir(project_dir)
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    60
            package_dir = osp.join(project_dir, 'cubicweb_foo')
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    61
            package_content = os.listdir(package_dir)
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    62
            self.assertItemsEqual(project_content, expected_project_content)
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    63
            self.assertItemsEqual(package_content, expected_package_content)
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    64
        finally:
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    65
            shutil.rmtree(tmpdir, ignore_errors=True)
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    66
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    67
    def test_flake8(self):
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    68
        """Ensure newcube built from skeleton is flake8-compliant"""
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    69
        tmpdir = tempfile.mkdtemp(prefix="temp-cwctl-newcube-flake8")
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    70
        try:
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    71
            newcube(tmpdir, 'foo')
11454
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    72
            cmd = [sys.executable, '-m', 'flake8',
7770559e3945 [devtools] Update skeleton and newcube command to cube as package layout
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11427
diff changeset
    73
                   osp.join(tmpdir, 'cubicweb-foo', 'cubicweb_foo')]
11176
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    74
            proc = Popen(cmd, stdout=PIPE, stderr=STDOUT)
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    75
            retcode = proc.wait()
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    76
        finally:
4a43193ce7b0 [test] Add a test ensuring new cube built from skeleton is flake8-compliant
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11175
diff changeset
    77
            shutil.rmtree(tmpdir, ignore_errors=True)
11427
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    78
        self.assertEqual(retcode, 0,
7d38eb1bcd1f [test] Check retcode of subprocesses in devctl tests
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11422
diff changeset
    79
                         msg=to_unicode(proc.stdout.read()))
10965
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    80
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    81
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    82
if __name__ == '__main__':
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    83
    from unittest import main
b1ba18016151 [skeleton] Fix broken spec file template
Rémi Cardona <remi.cardona@logilab.fr>
parents:
diff changeset
    84
    main()