mx_compat.py

#
# ----------------------------------------------------------------------------------------------------
#
# Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.
#
# This code 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
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#
# ----------------------------------------------------------------------------------------------------

import sys, inspect, re, types, bisect
from collections import OrderedDict
from os.path import join
import mx

class MxCompatibility500(object):
    @staticmethod
    def version():
        return mx.VersionSpec("5.0.0")

    def supportsLicenses(self):
        return False

    def licenseAttribute(self):
        return 'licence'

    def licensesAttribute(self):
        return 'licences'

    def defaultLicenseAttribute(self):
        return 'defaultLicence'

    def supportedMavenMetadata(self):
        return []

    def supportsRepositories(self):
        return False

    def newestInputIsTimeStampFile(self):
        '''
        Determines if the 'newestInput' parameter of BuildTask.needsBuild()
        is a TimeStampFile or a simple time stamp (i.e. a float).
        '''
        return False

    def getSuiteOutputRoot(self, suite):
        return suite.dir

    def mavenDeployJavadoc(self):
        return False

    def checkstyleLibraryName(self):
        return 'CHECKSTYLE_6.0'

    def __str__(self):
        return str("MxCompatibility({})".format(self.version()))

    def __repr__(self):
        return str(self)

class MxCompatibility520(MxCompatibility500):
    @staticmethod
    def version():
        return mx.VersionSpec("5.2.0")

    def supportsLicenses(self):
        return True

    def supportedMavenMetadata(self):
        return ['library-coordinates', 'suite-url', 'suite-developer', 'dist-description']

class MxCompatibility521(MxCompatibility520):
    @staticmethod
    def version():
        return mx.VersionSpec("5.2.1")

    def supportsRepositories(self):
        return True

class MxCompatibility522(MxCompatibility521):
    @staticmethod
    def version():
        return mx.VersionSpec("5.2.2")

    def licenseAttribute(self):
        return 'license'

    def licensesAttribute(self):
        return 'licenses'

    def defaultLicenseAttribute(self):
        return 'defaultLicense'

class MxCompatibility533(MxCompatibility522):
    @staticmethod
    def version():
        return mx.VersionSpec("5.3.3")

    def newestInputIsTimeStampFile(self):
        return True

class MxCompatibility555(MxCompatibility533):
    @staticmethod
    def version():
        return mx.VersionSpec("5.5.5")

    def getSuiteOutputRoot(self, suite):
        return join(suite.dir, 'mxbuild')

class MxCompatibility566(MxCompatibility555):
    @staticmethod
    def version():
        return mx.VersionSpec("5.6.6")

    def mavenDeployJavadoc(self):
        return True

class MxCompatibility5616(MxCompatibility566):#pylint: disable=too-many-ancestors
    @staticmethod
    def version():
        return mx.VersionSpec("5.6.16")

    def checkstyleLibraryName(self):
        return 'CHECKSTYLE_6.15'

def minVersion():
    _ensureCompatLoaded()
    return _versionsMap.keys()[0]

def getMxCompatibility(version):
    if version < minVersion():  # ensures compat loaded
        return None
    keys = _versionsMap.keys()
    return _versionsMap[keys[bisect.bisect_right(keys, version)-1]]

_versionsMap = OrderedDict()

def _ensureCompatLoaded():
    if not _versionsMap:

        def flattenClassTree(tree):
            root = tree[0][0]
            assert isinstance(root, types.TypeType), root
            yield root
            if len(tree) > 1:
                assert len(tree) == 2
                rest = tree[1]
                assert isinstance(rest, types.ListType), rest
                for c in flattenClassTree(rest):
                    yield c

        classes = []
        regex = re.compile(r'^MxCompatibility[0-9a-z]*$')
        for name, clazz in inspect.getmembers(sys.modules[__name__], inspect.isclass):
            m = regex.match(name)
            if m:
                classes.append(clazz)

        previousVersion = None
        for clazz in flattenClassTree(inspect.getclasstree(classes)):
            if clazz == object:
                continue
            assert previousVersion is None or previousVersion < clazz.version()
            previousVersion = clazz.version()
            _versionsMap[previousVersion] = clazz()