netci.groovy

//-------------------------------------------------------------------------------------------------------
// Copyright (C) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------

// Import the utility functionality.
import jobs.generation.Utilities;

// Grab the github project name passed in
def project = GithubProject
def branch = GithubBranchName

def msbuildTypeMap = [
    'debug':'chk',
    'test':'test',
    'release':'fre'
]

// convert `machine` parameter to OS component of PR task name
def machineTypeToOSTagMap = [
    'Windows 7': 'Windows 7',
    'Windows_NT': 'Windows',
    'Ubuntu14.04': 'Ubuntu14.04',
    'Ubuntu16.04': 'Ubuntu'
]

def dailyRegex = 'dailies'

// Only generate PR check triggers for the version of netci.groovy in the master branch
// since those PR checks will apply for all branches.
def jobTypesToGenerate = [false]
if (branch.startsWith('master')) {
    // OK to generate PR checks (this ensures we only generate one set of them)
    jobTypesToGenerate += true
}

// ---------------
// HELPER CLOSURES
// ---------------

def CreateBuildTasks = { machine, configTag, buildExtra, testExtra, runCodeAnalysis, excludeConfigIf, nonDefaultTaskSetup ->
    jobTypesToGenerate.each { isPR ->
        ['x86', 'x64', 'arm'].each { buildArch ->
            ['debug', 'test', 'release'].each { buildType ->
                if (excludeConfigIf && excludeConfigIf(isPR, buildArch, buildType)) {
                    return // early exit: we don't want to create a job for this configuration
                }

                def config = "${buildArch}_${buildType}"
                config = (configTag == null) ? config : "${configTag}_${config}"

                // params: Project, BaseTaskName, IsPullRequest (appends '_prtest')
                def jobName = Utilities.getFullJobName(project, config, isPR)

                def testableConfig = buildType in ['debug', 'test'] && buildArch != 'arm'
                def analysisConfig = buildType in ['release'] && runCodeAnalysis

                def buildScript = "call .\\jenkins\\buildone.cmd ${buildArch} ${buildType} "
                buildScript += buildExtra ?: ''
                buildScript += analysisConfig ? ' "/p:runcodeanalysis=true"' : ''
                def testScript = "call .\\jenkins\\testone.cmd ${buildArch} ${buildType} "
                testScript += testExtra ?: ''
                def analysisScript = '.\\Build\\scripts\\check_prefast_error.ps1 . CodeAnalysis.err'

                def newJob = job(jobName) {
                    // This opens the set of build steps that will be run.
                    // This looks strange, but it is actually a method call, with a
                    // closure as a param, since Groovy allows method calls without parens.
                    // (Compare with '.each' method used above.)
                    steps {
                        batchFile(buildScript) // run the parameter as if it were a batch file
                        if (testableConfig) {
                            batchFile(testScript)
                        }
                        if (analysisConfig) {
                            powerShell(analysisScript)
                        }
                    }
                }

                def msbuildType = msbuildTypeMap.get(buildType)
                def msbuildFlavor = "build_${buildArch}${msbuildType}"
                def archivalString = "test/${msbuildFlavor}.*,test/logs/**"
                archivalString += analysisConfig ? ',CodeAnalysis.err' : ''
                Utilities.addArchival(newJob, archivalString,
                    '', // no exclusions from archival
                    false, // doNotFailIfNothingArchived=false ~= failIfNothingArchived
                    false) // archiveOnlyIfSuccessful=false ~= archiveAlways

                Utilities.setMachineAffinity(newJob, machine, 'latest-or-auto')
                Utilities.standardJobSetup(newJob, project, isPR, "*/${branch}")

                if (nonDefaultTaskSetup == null) {
                    if (isPR) {
                        def osTag = machineTypeToOSTagMap.get(machine)
                        // Set up checks which apply to PRs targeting any branch
                        Utilities.addGithubPRTrigger(newJob, "${osTag} ${config}")
                        // To enable PR checks only for specific target branches, use the following instead:
                        // Utilities.addGithubPRTriggerForBranch(newJob, branch, checkName)
                    } else {
                        Utilities.addGithubPushTrigger(newJob)
                    }
                } else {
                    // nonDefaultTaskSetup is e.g. DailyBuildTaskSetup (which sets up daily builds)
                    // These jobs will only be configured for the branch specified below,
                    // which is the name of the branch netci.groovy was processed for.
                    // See list of such branches at:
                    // https://github.com/dotnet/dotnet-ci/blob/master/jobs/data/repolist.txt
                    nonDefaultTaskSetup(newJob, isPR, config)
                }
            }
        }
    }
}

def CreateLinuxBuildTasks = { machine, configTag, linuxBranch, nonDefaultTaskSetup ->
    [true, false].each { isPR ->
        ['debug', 'release'].each { buildType ->
            def config = "linux_${buildType}"
            config = (configTag == null) ? config : "${configTag}_${config}"

            // params: Project, BaseTaskName, IsPullRequest (appends '_prtest')
            def jobName = Utilities.getFullJobName(project, config, isPR)

            def testableConfig = buildType in ['debug']

            def infoScript = 'bash jenkins/get_system_info.sh'
            def debugFlag = buildType == 'debug' ? '--debug' : ''
            def buildScript = "bash ./build.sh -j=`nproc` ${debugFlag} --cxx=/usr/bin/clang++-3.8 --cc=/usr/bin/clang-3.8"
            def testScript = "bash test/runtests.sh"

            def newJob = job(jobName) {
                steps {
                    shell(infoScript)
                    shell(buildScript)
                    if (testableConfig) {
                        shell(testScript)
                    }
                }
            }

            def archivalString = "BuildLinux/build.log"
            Utilities.addArchival(newJob, archivalString,
                '', // no exclusions from archival
                true, // doNotFailIfNothingArchived=false ~= failIfNothingArchived (true ~= doNotFail)
                false) // archiveOnlyIfSuccessful=false ~= archiveAlways

            Utilities.setMachineAffinity(newJob, machine, 'latest-or-auto')
            Utilities.standardJobSetup(newJob, project, isPR, "*/${branch}")

            if (nonDefaultTaskSetup == null) {
                if (isPR) {
                    def osTag = machineTypeToOSTagMap.get(machine)
                    // Set up checks which apply to PRs targeting any branch
                    Utilities.addGithubPRTriggerForBranch(newJob, linuxBranch, "${osTag} ${config}")
                    // To enable PR checks only for specific target branches, use the following instead:
                    // Utilities.addGithubPRTriggerForBranch(newJob, branch, checkName)
                } else {
                    Utilities.addGithubPushTrigger(newJob)
                }
            } else {
                // nonDefaultTaskSetup is e.g. DailyBuildTaskSetup (which sets up daily builds)
                // These jobs will only be configured for the branch specified below,
                // which is the name of the branch netci.groovy was processed for.
                // See list of such branches at:
                // https://github.com/dotnet/dotnet-ci/blob/master/jobs/data/repolist.txt
                nonDefaultTaskSetup(newJob, isPR, config)
            }
        }
    }
}

def DailyBuildTaskSetup = { newJob, isPR, triggerName, groupRegex ->
    // The addition of triggers makes the job non-default in GitHub.
    if (isPR) {
        def triggerRegex = "(${dailyRegex}|${groupRegex}|${triggerName})"
        Utilities.addGithubPRTrigger(newJob,
            triggerName, // GitHub task name
            "(?i).*test\\W+${triggerRegex}.*")
    } else {
        Utilities.addPeriodicTrigger(newJob, '@daily')
    }
}

def CreateStyleCheckTasks = { taskString, taskName, checkName ->
    [true, false].each { isPR ->
        def jobName = Utilities.getFullJobName(project, taskName, isPR)

        def newJob = job(jobName) {
            steps {
                shell(taskString)
            }
        }

        Utilities.standardJobSetup(newJob, project, isPR, "*/${branch}")
        if (isPR) {
            // Set PR trigger.
            Utilities.addGithubPRTrigger(newJob, checkName)
        } else {
            // Set a push trigger
            Utilities.addGithubPushTrigger(newJob)
        }

        Utilities.setMachineAffinity(newJob, 'Ubuntu14.04', 'latest-or-auto')
    }
}

// ----------------
// INNER LOOP TASKS
// ----------------

CreateBuildTasks('Windows_NT', null, null, null, true, null, null)

// -----------------
// DAILY BUILD TASKS
// -----------------

if (!branch.endsWith('-ci')) {
    // build and test on Windows 7 with VS 2013 (Dev12/MsBuild12)
    CreateBuildTasks('Windows 7', 'daily_dev12', 'msbuild12', '-win7 -includeSlow', false,
        /* excludeConfigIf */ { isPR, buildArch, buildType -> (buildArch == 'arm') },
        /* nonDefaultTaskSetup */ { newJob, isPR, config ->
            DailyBuildTaskSetup(newJob, isPR,
                "Windows 7 ${config}",
                '(dev12|legacy)\\s+tests')})

    // build and test on the usual configuration (VS 2015) with -includeSlow
    CreateBuildTasks('Windows_NT', 'daily_slow', null, '-includeSlow', false,
        /* excludeConfigIf */ null,
        /* nonDefaultTaskSetup */ { newJob, isPR, config ->
            DailyBuildTaskSetup(newJob, isPR,
                "Windows ${config}",
                'slow\\s+tests')})

    // build and test on the usual configuration (VS 2015) with JIT disabled
    CreateBuildTasks('Windows_NT', 'daily_disablejit', '"/p:BuildJIT=false"', '-disablejit', true,
        /* excludeConfigIf */ null,
        /* nonDefaultTaskSetup */ { newJob, isPR, config ->
            DailyBuildTaskSetup(newJob, isPR,
                "Windows ${config}",
                '(disablejit|nojit)\\s+tests')})
}

// ----------------
// CODE STYLE TASKS
// ----------------

CreateStyleCheckTasks('./jenkins/check_eol.sh', 'ubuntu_check_eol', 'EOL Check')
CreateStyleCheckTasks('./jenkins/check_copyright.sh', 'ubuntu_check_copyright', 'Copyright Check')

// -----------------
// LINUX BUILD TASKS
// -----------------

if (branch.startsWith('linux')) {
    osString = 'Ubuntu16.04'

    // PR checks
    CreateLinuxBuildTasks(osString, "ubuntu", branch, null)

    // daily builds
    if (!branch.endsWith('-ci')) {
        CreateLinuxBuildTasks(osString, "daily_ubuntu", branch,
            /* nonDefaultTaskSetup */ { newJob, isPR, config ->
                DailyBuildTaskSetup(newJob, isPR,
                    "Ubuntu ${config}",
                    'linux\\s+tests')})
    }
}