Class: Autoproj::Jenkins::Updater

Inherits:
Object
  • Object
show all
Defined in:
lib/autoproj/jenkins/updater.rb

Overview

Update a jenkins server configuration from an autoproj workspace

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ws, server, job_prefix: '') ⇒ Updater

Create a new updater context for an autoproj workspace and Jenkins server

Parameters:

  • ws (Autoproj::Workspace)
  • server (Server)
  • job_prefix (String) (defaults to: '') —

    a string that should be prefixed to all job names



33
34
35
36
37
 
# File 'lib/autoproj/jenkins/updater.rb', line 33

def initialize(ws, server, job_prefix: '')
    @ws = ws
    @server = server
    @job_prefix = job_prefix
end

Instance Attribute Details

#job_prefix ⇒ String (readonly)

A string that is prefixed to all job names

Returns:

  • (String) 


24
25
26
 
# File 'lib/autoproj/jenkins/updater.rb', line 24

def job_prefix
  @job_prefix
end

#server ⇒ Server (readonly)

The server we have to update

Returns:



19
20
21
 
# File 'lib/autoproj/jenkins/updater.rb', line 19

def server
  @server
end

#ws ⇒ Autoproj::Workspace (readonly)

The autoproj workspace

Returns:

  • (Autoproj::Workspace) 


14
15
16
 
# File 'lib/autoproj/jenkins/updater.rb', line 14

def ws
  @ws
end

Instance Method Details

#compute_downstream_packages(package, reverse_dependencies) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/autoproj/jenkins/updater.rb', line 118

def compute_downstream_packages(package, reverse_dependencies)
    queue   = [package.name]
    results = Set.new
    while !queue.empty?
        p_name = queue.shift
        if !results.include?(p_name)
            results << p_name
            queue.concat(reverse_dependencies[p_name].to_a)
        end
    end
    results.delete(package.name)
    results
end

#compute_job_to_package_map(package_names, included_package_names) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/autoproj/jenkins/updater.rb', line 132

def compute_job_to_package_map(package_names, included_package_names)
    result = Hash.new
    package_names.each do |pkg_name|
        if included_package_names.include?(pkg_name)
            job_name = job_name_from_package_name(pkg_name)
            result[job_name] = pkg_name
        end
    end
    result
end

#compute_upstream_packages(package) ⇒ Object 



109
110
111
112
113
114
115
116
 
# File 'lib/autoproj/jenkins/updater.rb', line 109

def compute_upstream_packages(package)
    upstream_packages = package.autobuild.dependencies.inject(Set.new) do |all, pkg_name|
        all << pkg_name
        ws.manifest.find_autobuild_package(pkg_name).all_dependencies(all)
    end
    upstream_packages.delete(package.name)
    upstream_packages
end

#create_or_update_buildconf_job(*package_names, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, quiet_period: 5, credentials_id: nil, vcs_credentials: Credentials.new) ⇒ Object

Create or update the buildconf (master) job

Parameters:

  • packages (Array<Autoproj::PackageDefinition>) —

    if non-empty, restrict operations to these packages and their dependencies

  • gemfile (String) (defaults to: 'buildconf-Gemfile') —

    the gemfile template that should be used for the autoproj bootstrap. Mostly used for autoproj-jenkins development within VMs

  • quiet_period (Integer) (defaults to: 5) —

    the job's quiet period, in seconds. Mostly used within autoproj-jenkins tests



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/autoproj/jenkins/updater.rb', line 80

def create_or_update_buildconf_job(*package_names, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, quiet_period: 5, credentials_id: nil, vcs_credentials: Credentials.new)
    job_name = job_name_from_package_name("buildconf")

    pipeline = render_buildconf_pipeline(
        *package_names,
        gemfile: gemfile,
        autoproj_install_path: autoproj_install_path,
        credentials_id: credentials_id,
        vcs_credentials: vcs_credentials,
        dev: dev)
    server.create_or_reset_job(job_name, 'buildconf.xml', pipeline: pipeline, quiet_period: quiet_period)
end

#job_name_from_package_name(package_name) ⇒ String

Returns the job name of a given package

Parameters:

  • package_name (String)

Returns:

  • (String) 


97
98
99
 
# File 'lib/autoproj/jenkins/updater.rb', line 97

def job_name_from_package_name(package_name)
    "#{job_prefix}#{package_name.gsub('/', '-')}"
end

#package_by_name(package_name) ⇒ Object

Resolve a package by its name



102
103
104
105
106
107
 
# File 'lib/autoproj/jenkins/updater.rb', line 102

def package_by_name(package_name)
    package = ws.manifest.find_package_definition(package_name)
    if !package
        raise ArgumentError, "no package called #{package_name}"
    end
end

#render_buildconf_pipeline(*package_names, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, credentials_id: nil, vcs_credentials: Credentials.new) ⇒ Object

Update the buildconf pipeline

Parameters:

  • jenkins_url (String) —

    the URL of the jenkins server from the point of view of the job's execution

  • gemfile (String) (defaults to: 'buildconf-Gemfile') —

    the gemfile template that should be used for the autoproj bootstrap. Mostly used for autoproj-jenkins development within VMs

  • autoproj_install_path (String) (defaults to: nil) —

    a path local to the jenkins workspace where the autoproj_install script will be. If unset, downloads it from github.com

  • dev (Boolean) (defaults to: false) —

    whether the packages pipelines should be updated with --dev or not

  • packages (Array<Autoproj::PackageDefinition>) —

    if non-empty, restrict operations to these packages and their dependencies



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/autoproj/jenkins/updater.rb', line 53

def render_buildconf_pipeline(*package_names, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, credentials_id: nil, vcs_credentials: Credentials.new)
    manifest_vcs = ws.manifest.vcs
    if manifest_vcs.local? || manifest_vcs.none?
        raise ArgumentError, "cannot use Jenkins to build an autoproj buildconf that is not on a remotely acessible VCS"
    end

    job_name = job_name_from_package_name("buildconf")
    server.render_pipeline(job_name, 'buildconf.pipeline',
        vcs: manifest_vcs,
        package_names: package_names,
        gemfile: gemfile,
        autoproj_install_path: autoproj_install_path,
        job_prefix: job_prefix,
        credentials_id: credentials_id,
        vcs_credentials: vcs_credentials,
        dev: dev)
end

#update(*packages, quiet_period: 5, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, vcs_credentials: Credentials.new) ⇒ Array<String>

Create jobs and dependencies to handle the given set of packages

Returns:

  • (Array<String>) —

    the list of names of the jobs that have been created/updated



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/autoproj/jenkins/updater.rb', line 147

def update(*packages, quiet_period: 5, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, vcs_credentials: Credentials.new)
    reverse_dependencies = ws.manifest.compute_revdeps

    package_names = packages.map(&:name).to_set
    packages.map do |package|
        job_name = job_name_from_package_name(package.name)
        if !Autoproj::Jenkins.vcs_supported?(package.vcs.type)
            raise UnhandledVCS, "the #{package.vcs.type} importer, used by #{package.name}, is not supported by autoproj-jenkins"
        end

        upstream_jobs   = compute_job_to_package_map(compute_upstream_packages(package), package_names)
        downstream_jobs = compute_job_to_package_map(compute_downstream_packages(package, reverse_dependencies), package_names)

        prefix_relative_path =
            if package.autobuild.srcdir == package.autobuild.prefix
                Pathname.new(package.autobuild.srcdir).
                    relative_path_from(Pathname.new(ws.root_dir)).to_s
            else
                "install/#{package.name}"
            end

        pipeline = server.render_pipeline(job_name, 'package.pipeline',
            buildconf_vcs: ws.manifest.vcs,
            vcs: package.vcs,
            package_name: package.name,
            package_dir: Pathname.new(package.autobuild.srcdir).relative_path_from(Pathname.new(ws.root_dir)).to_s,
            artifact_glob: "**/*",
            job_name: job_name,
            upstream_jobs: upstream_jobs,
            downstream_jobs: downstream_jobs,
            gemfile: gemfile,
            autoproj_install_path: autoproj_install_path,
            vcs_credentials: vcs_credentials)

        server.create_or_reset_job(
            job_name, 'package.xml',
            pipeline: pipeline,
            quiet_period: quiet_period)

        job_name
    end
end