test.py

#!/usr/bin/python -B
import shutil
import sys
import unittest
import tempfile

from jenkins_tools import artifactory_utils

# Generic fake server to test things that shouldn't connect
TEST_SERVER = 'http://serv.er/path'


class ArtifactSelectorTestCase(unittest.TestCase):

    def _get_paths(self, versions):
        """Convert the supplied versions to fake artifactory paths

        Returns an iterator of objects that, like real artifactory path
        objects, require explicit conversion to string.
        """
        class VersionWrapper(object):
            def __init__(self, version):
                self._version = version

            def __str__(self):
                return ('%s/proj/rev/plat/proj-rev-%s-debug-stable.tar.bz2' %
                        (TEST_SERVER, self._version))

        for version in versions:
            yield VersionWrapper(version)

    def _test_filter(self, version_spec, server_versions, res_idx_list):
        """Generic test for selector version filter

        version_spec is what gets passed to the selector.
        semver_versions is a list of versions we pretend are available.
        res_idx_list lists indices from the semver_versions that should pass.

        Ideally we would just test all(), which every attempt to reduce an
        ArtifactSelector to an Artifact should pass through, but that would
        require either mocking out a ton of the artifactory module or locally
        running an artifactory server for the test.  So we just test filter,
        which has most of the complexity of all() and is "public", though not
        well documented.
        """
        sel = artifactory_utils.ArtifactSelector(
            version=version_spec,
            server=TEST_SERVER
        )
        paths = list(self._get_paths(server_versions))
        res = list(sel.filter(iter(paths)))

        # Verify that filter returns the path objects and not strings
        for res_path, idx in zip(res, res_idx_list):
            self.assertIs(res_path, paths[idx])
        self.assertEqual(len(res), len(res_idx_list))

    def test_glob_versions(self):
        # For globs we currently don't filter anything locally since the
        # artifactory module does that for us.
        self._test_filter('*', ['0.0.0.0', '9.0.2.10', '1', 'beans'], range(4))
        self._test_filter('4.*', ['4.0.0.0', '4.0.4', '4.'], range(3))
        self._test_filter('4.0.0.0', ['4.0.0.0'], [0])

    def test_npm_tilde(self):
        self._test_filter(
            '~1.2.3',
            ['1.2.3.0', '1.2.3.123', '1.2.4.0', '1.2.5.125',
             '1.0.2.3', '1.3.0.2', '2.0.1.3', '0.123.0.0', '1.2.0.0'],
            range(4))
        self._test_filter(
            '~1.2.3.4',
            ['1.2.3.4', '1.2.3.123', '1.2.4.0', '1.2.5.125',
             '1.2.3.3', '1.3.0.2', '2.0.1.3', '0.123.0.0', '1.2.0.0'],
            range(4))
        self._test_filter(
            '~1.2',
            ['1.2.0.0', '1.2.4.0', '1.2.0.9',
             '1.3.0.2', '2.0.1.3', '0.123.0.0', '1.0.0.0'],
            range(3))
        self._test_filter(
            '~1',
            ['1.0.0.0', '1.0.12.34',
             '1.3.0.2', '2.0.1.3', '0.123.0.0', '0.0.0.0'],
            range(2))
        self._test_filter(
            '~0.2.3',
            ['0.2.3.0', '0.2.3.123', '0.2.4.0', '0.2.5.125',
             '0.0.2.3', '0.3.0.2', '1.0.1.3', '0.0.0.0'],
            range(4))

    def test_npm_caret(self):
        self._test_filter(
            '^1.2.3',
            ['1.2.3.0', '1.2.3.123', '1.2.4.0', '1.5.0.0', '1.3.5.7',
             '1.0.2.3', '1.2.2.9', '2.0.1.3', '0.123.0.0', '1.2.0.0'],
            range(5))
        self._test_filter(
            '^1.2.3.4',
            ['1.2.3.4', '1.2.3.123', '1.2.4.0', '1.5.0.0', '1.3.5.7',
             '1.2.3.3', '1.2.2.9', '2.0.1.3', '0.123.0.0', '1.2.0.0'],
            range(5))
        self._test_filter(
            '^1.2',
            ['1.2.0.0', '1.2.4.0', '1.2.0.9', '1.5.0.0', '1.3.5.7',
             '2.0.0.0', '2.3.4.5', '0.123.0.0'],
            range(5))
        self._test_filter(
            '^1',
            ['1.0.0.0', '1.0.4.0', '1.0.0.9', '1.5.0.0', '1.3.5.7',
             '2.0.0.0', '2.3.4.5', '0.123.0.0'],
            range(5))
        self._test_filter(
            '^0.2.3',
            ['0.2.3.0', '0.2.3.123', '0.2.4.0', '0.2.5.125',
             '0.0.2.3', '0.3.0.2', '2.0.1.3', '0.123.0.0', '0.2.0.0'],
            range(4))
        self._test_filter(
            '^0.2.3.4',
            ['0.2.3.4', '0.2.3.123', '0.2.4.0', '0.2.5.125',
             '0.2.3.3', '0.3.0.2', '2.0.1.3', '0.123.0.0', '0.2.0.0'],
            range(4))
        self._test_filter(
            '^0.2',
            ['0.2.0.0', '0.2.4.0', '0.2.0.9',
             '0.3.0.2', '2.0.1.3', '0.123.0.0', '0.0.0.0'],
            range(3))
        # Not going to bother testing ^0.0.* because I don't care at all


class RevsTrackerTestCase(unittest.TestCase):
    def setUp(self):
        self.install_dir = tempfile.mkdtemp()

    def tearDown(self):
        try:
            shutil.rmtree(self.install_dir)
        except Exception:
            pass

    def _make_tracker(self):
        return artifactory_utils.RevsTracker(self.install_dir)

    def _write_revs(self, revs):
        t = self._make_tracker()
        t.revs = revs
        t.write_revs()

    def _check_revs(self, revs):
        t = self._make_tracker()
        t.read_revs()
        self.assertEqual(revs, t.revs)

    def test_rw(self):
        self._write_revs({'arbit': 'rary', 'bull': 'shit'})
        self._check_revs({'arbit': 'rary', 'bull': 'shit'})

    def _make_artifact(self, proj='test_proj', rev='test_rev',
                       platform='test_platform'):
        return artifactory_utils.Artifact(
            proj, platform, rev, '0.0.0.0', False, False, server=TEST_SERVER)

    def _named_revs(self, revs, *args, **kwargs):
        artifact = self._make_artifact(*args, **kwargs)
        revs['name'] = artifact.name
        return revs

    def test_deps(self):
        p1_revs = self._named_revs({'arbit': 'rary', 'bull': 'shit'}, 'p1')
        p1_name = p1_revs['name']
        p2_revs = self._named_revs({'more': 'of', 'the': 'same'}, 'p2')
        p2_name = p2_revs['name']
        p3_name = self._make_artifact('p3').name
        p4_name = self._make_artifact('p4').name

        t = self._make_tracker()
        t.revs['name'] = p3_name
        self._write_revs(p1_revs)
        t.take_artifact_revs(self._make_artifact('p1'))
        self._write_revs(p2_revs)
        t.take_artifact_revs(self._make_artifact('p2'))
        t.write_revs()

        self._check_revs({
            'name': p3_name,
            'dependencies': [p1_name, p2_name],
            'dependency_details': {
                p1_name: {'arbit': 'rary', 'bull': 'shit'},
                p2_name: {'more': 'of', 'the': 'same'},
            }
        })

        t = self._make_tracker()
        t.take_artifact_revs(self._make_artifact('p3'))
        t.take_artifact_revs(self._make_artifact('p4'))
        t.write_revs()

        self._check_revs({
            'dependencies': [p3_name, p4_name],
            'dependency_details': {
                p1_name: {'arbit': 'rary', 'bull': 'shit'},
                p2_name: {'more': 'of', 'the': 'same'},
                p3_name: {'dependencies': [p1_name, p2_name]},
                p4_name: None,
            }
        })

if '__main__' == __name__:
    unittest.main()