pyjenkins.py

from com.tanium.python import PyJenkinsBuild, BuildResultException
from com.tanium.util import JenkinsHelper
from hudson import AbortException
from hudson.model import Result
from jenkins.model import Jenkins

context = None
shared_context = None
config = None
build = None
launcher = None
listener = None
logger = None
env_vars = None
review_build = False

def init(new_context, new_config):
    assert new_context is not None
    assert new_config is not None
    global context, shared_context, config, build, launcher, listener, logger, env_vars
    context = new_context
    shared_context = new_context.sharedContext
    config = new_config
    build = context.build
    launcher = context.launcher
    listener = context.listener
    logger = listener.getLogger()
    env_vars = JenkinsHelper.getEnvVars(context)
    logger.println("pyjenkins module initialized!")
    return True

def register_pybuild(pybuild):
    assert context is not None
    logger.println("Registering pyjenkins build")
    context.pybuild = pybuild

def report_tests(test_file_pattern):
    return JenkinsHelper.reportTests(context, test_file_pattern)

def archive_artifacts(source_patterns):
    JenkinsHelper.archiveArtifacts(context, source_patterns)

def execute(cmds):
    return JenkinsHelper.execute(context, cmds, env_vars)

def execute_or_fail(cmds):
    result = execute(cmds)
    if not result:
        listener.fatalError("Command failed: " + str(cmds))
        raise BuildResultException(Result.FAILURE)

def is_windows():
    return JenkinsHelper.isNodeWindows(context)

def remote_file(relative_path):
    return JenkinsHelper.getRemoteFile(context, relative_path)

def read_remote_file(relative_path):
    return remote_file(relative_path).readToString()

def env(var):
    return env_vars.get(var)

def env_set(var, value):
    if value is None:
        env_vars.remove(var)
    else:
        env_vars.put(var, value)

def ensure_has_plugin(plugin_name):
    if Jenkins.getInstance().getPlugin(plugin_name) is None:
        raise AbortException("Plugin '" + plugin_name + "' is not installed!")

def trigger_job(job_name, params=None):
    return JenkinsHelper.triggerJob(context, job_name, params)

def trigger_jobs(job_names, params=None):
    return JenkinsHelper.triggerJobs(context, job_names, params)

def trigger_job_and_wait(job_name, params=None, wait_millis=0):
    return JenkinsHelper.triggerJobAndWait(context, job_name, params, wait_millis)

def trigger_jobs_and_wait(job_names, params=None, wait_millis=0):
    return JenkinsHelper.triggerJobsAndWait(context, job_names, params, wait_millis)

def wait_for_job_start(job, wait_millis=0):
    return JenkinsHelper.waitForJobToStart(context, job, wait_millis)

def wait_for_jobs_start(jobs, wait_millis=0):
    return JenkinsHelper.waitForJobsToStart(context, jobs, wait_millis)

def wait_for_job(job, wait_millis=0):
    return JenkinsHelper.waitForJob(context, job, wait_millis)

def wait_for_jobs(jobs, wait_millis=0):
    if isinstance(jobs, list):
         return JenkinsHelper.waitForJobsList(context, jobs, wait_millis)
    else:
        return JenkinsHelper.waitForJobs(context, jobs, wait_millis)

def run_git(args, with_auth=False):
    return JenkinsHelper.runGit(context, args, env_vars, with_auth)

def is_pull_request_build():
    return config.pullRequestBuild == True

def is_release_build():
    return config.releaseBuild == True

__all__ = [ "PyJenkinsBuild",
            "Result",
            "build",
            "launcher",
            "listener",
            "logger",
            "register_pybuild",
            "report_tests",
            "archive_artifacts",
            "execute",
            "execute_or_fail",
            "is_windows",
            "remote_file",
            "read_remote_file",
            "env",
            "env_set",
            "ensure_has_plugin",
            "trigger_job",
            "trigger_jobs",
            "trigger_job_and_wait",
            "trigger_jobs_and_wait",
            "wait_for_job_start",
            "wait_for_jobs_start",
            "wait_for_job",
            "wait_for_jobs",
            "run_git",
            "is_pull_request_build",
            "is_release_build",
            "shared_context",
          ]