sap-jenkins-library/test/groovy/ToolValidateTest.groovy

import static com.lesfurets.jenkins.unit.global.lib.LibraryConfiguration.library
import static ProjectSource.projectSource

import org.apache.commons.exec.*
import hudson.AbortException
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.ExpectedException
import org.junit.rules.TemporaryFolder
import com.lesfurets.jenkins.unit.BasePipelineTest


class ToolValidateTest extends BasePipelineTest {


    @Rule
    public ExpectedException thrown = new ExpectedException().none()

    @Rule
    public TemporaryFolder tmp = new TemporaryFolder()

    private notEmptyDir
    private messages = []
    private script


    @Before
    void setup() {

        super.setUp()

        def piperLib = library()
                .name('piper-library-os')
                .retriever(projectSource())
                .targetPath('clonePath/is/not/necessary')
                .defaultVersion('irrelevant')
                .allowOverride(true)
                .implicit(false)
                .build()

        helper.registerSharedLibrary(piperLib)

        helper.registerAllowedMethod('echo', [String], {s -> messages.add(s)})

        def pipelinePath = "${tmp.newFolder("pipeline").toURI().getPath()}pipeline"
        createPipeline(pipelinePath)
        script = loadScript(pipelinePath)

        notEmptyDir = tmp.newFolder('notEmptyDir')
        def path = "${notEmptyDir.getAbsolutePath()}${File.separator}test.txt"
        File file = new File(path)
        file.createNewFile()

        binding.setVariable('JAVA_HOME', notEmptyDir.getAbsolutePath())

        binding.setVariable('home', notEmptyDir.getAbsolutePath())

    }


    @Test
    void nullHomeTest() {

        thrown.expect(IllegalArgumentException)
        thrown.expectMessage("The parameter 'home' can not be null or empty.")

        binding.setVariable('tool', 'java')
        binding.setVariable('home', null)

        script.execute()
    }

    @Test
    void emptyHomeTest() {

        thrown.expect(IllegalArgumentException)
        thrown.expectMessage("The parameter 'home' can not be null or empty.")

        binding.setVariable('tool', 'java')
        binding.setVariable('home', '')

        script.execute()
    }

    @Test
    void nullToolTest() {

        thrown.expect(IllegalArgumentException)
        thrown.expectMessage("The parameter 'tool' can not be null or empty.")

        binding.setVariable('tool', null)

        script.execute()
    }

    @Test
    void emptyToolTest() {

        thrown.expect(IllegalArgumentException)
        thrown.expectMessage("The parameter 'tool' can not be null or empty.")

        binding.setVariable('tool', '')

        script.execute()
    }

    @Test
    void invalidToolTest() {

        thrown.expect(AbortException)
        thrown.expectMessage("The tool 'test' is not supported.")

        binding.setVariable('tool', 'test')

        script.execute()
    }

    @Test
    void unableToValidateJavaTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The validation of Java failed.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getNoVersion(m) })
        binding.setVariable('tool', 'java')

        script.execute()
    }

    @Test
    void unableToValidateMtaTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The validation of SAP Multitarget Application Archive Builder failed.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getNoVersion(m) })
        binding.setVariable('tool', 'mta')

        script.execute()
    }

    @Test
    void unableToValidateNeoTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The validation of SAP Cloud Platform Console Client failed.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getNoVersion(m) })
        binding.setVariable('tool', 'neo')

        script.execute()
    }

    @Test
    void unableToValidateCmTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The validation of Change Management Command Line Interface failed.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getNoVersion(m) })
        binding.setVariable('tool', 'cm')

        script.execute()
    }

    @Test
    void validateIncompatibleVersionJavaTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The installed version of Java is 1.7.0.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getIncompatibleVersion(m) })
        binding.setVariable('tool', 'java')

        script.execute()
    }

    @Test
    void validateIncompatibleVersionMtaTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The installed version of SAP Multitarget Application Archive Builder is 1.0.5.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getIncompatibleVersion(m) })
        binding.setVariable('tool', 'mta')

        script.execute()
    }

    @Test
    void validateNeoIncompatibleVersionTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The installed version of SAP Cloud Platform Console Client is 1.126.51.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getIncompatibleVersion(m) })
        binding.setVariable('tool', 'neo')

        script.execute()
    }

    @Test
    void validateCmIncompatibleVersionTest() {

        thrown.expect(AbortException)
        thrown.expectMessage('The installed version of Change Management Command Line Interface is 0.0.0.')

        helper.registerAllowedMethod('sh', [Map], { Map m -> getIncompatibleVersion(m) })
        binding.setVariable('tool', 'cm')

        script.execute()
    }

    @Test
    void validateJavaTest() {

        helper.registerAllowedMethod('sh', [Map], { Map m -> getVersion(m) })
        binding.setVariable('tool', 'java')

        script.execute()

        assert messages[0].contains('--- BEGIN LIBRARY STEP: toolValidate.groovy ---')
        assert messages[1].contains('[INFO] Validating Java version 1.8.0 or compatible version.')
        assert messages[2].contains('[INFO] Java version 1.8.0 is installed.')
        assert messages[3].contains('--- END LIBRARY STEP: toolValidate.groovy ---')
    }

    @Test
    void validateMtaTest() {

        helper.registerAllowedMethod('sh', [Map], { Map m -> getVersion(m) })
        binding.setVariable('tool', 'mta')

        script.execute()

        assert messages[0].contains('--- BEGIN LIBRARY STEP: toolValidate.groovy ---')
        assert messages[1].contains('[INFO] Validating SAP Multitarget Application Archive Builder version 1.0.6 or compatible version.')
        assert messages[2].contains('[INFO] SAP Multitarget Application Archive Builder version 1.0.6 is installed.')
        assert messages[3].contains('--- END LIBRARY STEP: toolValidate.groovy ---')
    }

    @Test
    void validateNeoTest() {

        helper.registerAllowedMethod('sh', [Map], { Map m -> getVersion(m) })
        binding.setVariable('tool', 'neo')

        script.execute()

        assert messages[0].contains('--- BEGIN LIBRARY STEP: toolValidate.groovy ---')
        assert messages[1].contains('[INFO] Validating SAP Cloud Platform Console Client version 3.39.10 or compatible version.')
        assert messages[2].contains('[INFO] SAP Cloud Platform Console Client version 3.39.10 is installed.')
        assert messages[3].contains('--- END LIBRARY STEP: toolValidate.groovy ---')
    }

    @Test
    void validateCmTest() {

        helper.registerAllowedMethod('sh', [Map], { Map m -> getVersion(m) })
        binding.setVariable('tool', 'cm')

        script.execute()

        assert messages[0].contains('--- BEGIN LIBRARY STEP: toolValidate.groovy ---')
        assert messages[1].contains('[INFO] Validating Change Management Command Line Interface version 0.0.1 or compatible version.')
        assert messages[2].contains('[INFO] Change Management Command Line Interface version 0.0.1 is installed.')
        assert messages[3].contains('--- END LIBRARY STEP: toolValidate.groovy ---')
    }


    private createPipeline(pipelinePath){
        new File(pipelinePath) <<   """
                                @Library('piper-library-os')

                                execute() {

                                  node() {

                                    toolValidate tool: tool, home: home
                                  }
                                }

                                return this
                                """
    }

    private getNoVersion(Map m) { 
        throw new AbortException('script returned exit code 127')
    }

    private getVersion(Map m) {

        if(m.script.contains('java -version')) {
            return '''openjdk version \"1.8.0_121\"
                    OpenJDK Runtime Environment (build 1.8.0_121-8u121-b13-1~bpo8+1-b13)
                    OpenJDK 64-Bit Server VM (build 25.121-b13, mixed mode)'''
        } else if(m.script.contains('mta.jar -v')) {
            return '1.0.6'
        } else if(m.script.contains('neo.sh version')) {
            return '''SAP Cloud Platform Console Client
                    SDK version    : 3.39.10
                    Runtime        : neo-java-web'''
        } else if(m.script.contains('cmclient -v')) {
            return '0.0.1-beta-2 : fc9729964a6acf5c1cad9c6f9cd6469727625a8e'
        }
    }

    private getIncompatibleVersion(Map m) {

        if(m.script.contains('java -version')) {
            return '''openjdk version \"1.7.0_121\"
                    OpenJDK Runtime Environment (build 1.7.0_121-8u121-b13-1~bpo8+1-b13)
                    OpenJDK 64-Bit Server VM (build 25.121-b13, mixed mode)'''
        } else if(m.script.contains('mta.jar -v')) {
            return '1.0.5'
        } else if(m.script.contains('neo.sh version')) {
            return '''SAP Cloud Platform Console Client
                    SDK version    : 1.126.51
                    Runtime        : neo-java-web'''
        } else if(m.script.contains('cmclient -v')) {
            return '0.0.0-beta-1 : fc9729964a6acf5c1cad9c6f9cd6469727625a8e'
        }
    }
}