def configure_admin(self): """Configure the admin user.""" hookenv.log("Configuring user for jenkins") admin = self._admin_data() api = Api(packages=self._packages) api.update_password(admin.username, admin.password) # Save the password to a file. It's not used directly by this charm # but it's convenient for integration with third-party tools. host.write_file(paths.ADMIN_PASSWORD, admin.password.encode("utf-8"), owner="root", group="root", perms=0o0600) if not os.path.exists(paths.LAST_EXEC): # This mean it's the very first time we configure the user, # and we want to create this file in order to avoid Jenkins # presenting the setup wizard. host.write_file(paths.LAST_EXEC, "{}\n".format(api.version()).encode("utf-8"), owner="jenkins", group="nogroup", perms=0o0600)
def test_check_ready_unavailable(self): """ If the backend keeps returning 5xx, an error is raised. """ api = Api() self.fakes.network.get(api.url, status_code=500) self.assertRaises(ServiceUnavailable, self.service.check_ready)
def install(self, plugins): """Install the given plugins, optionally removing unlisted ones. @params plugins: A whitespace-separated list of plugins to install. """ hookenv.log("Starting plugins installation process") plugins = plugins or "" plugins = plugins.split() plugins = self._get_plugins_to_install(plugins) host.mkdir(paths.PLUGINS, owner="jenkins", group="jenkins", perms=0o0755) existing_plugins = set(glob.glob("%s/*.jpi" % paths.PLUGINS)) try: installed_plugins = self._install_plugins(plugins) except Exception: hookenv.log("Plugin installation failed, check logs for details") raise unlisted_plugins = existing_plugins - installed_plugins if unlisted_plugins: if hookenv.config()["remove-unlisted-plugins"] == "yes": self._remove_plugins(unlisted_plugins) else: hookenv.log("Unlisted plugins: (%s) Not removed. Set " "remove-unlisted-plugins to 'yes' to clear them " "away." % ", ".join(unlisted_plugins)) # Restarting jenkins to pickup configuration changes Api().restart() return installed_plugins
def configure_admin(): remove_state("jenkins.configured.admin") api = Api() status_set("maintenance", "Configuring Jenkins public url") configuration = Configuration() needs_restart = configuration.set_url() if needs_restart: status_set("maintenance", "Restarting Jenkins") service_restart('jenkins') api.wait() status_set("maintenance", "Configuring proxy settings") configuration.configure_proxy() service_restart('jenkins') api.wait() status_set("maintenance", "Configuring admin user") users = Users() users.configure_admin() api.reload() api.wait() # Wait for the service to be fully up # Inform any extension that the username/password changed if get_state("extension.connected"): extension_relation = (RelationBase.from_state("extension.connected")) extension_relation.joined() set_state("jenkins.configured.admin")
def setUp(self): super(ApiTest, self).setUp() self.useFixture(JenkinsConfiguredAdmin(self.fakes)) self.fakes.jenkins.scripts[GET_LEGACY_TOKEN_SCRIPT.format( "admin")] = "abc\n" self.fakes.jenkins.scripts[GET_NEW_TOKEN_SCRIPT.format( "admin")] = "xyz\n" self.apt = AptStub() self.packages = Packages(apt=self.apt) self.api = Api(packages=self.packages)
def add_slaves(master): slaves = master.slaves() if not data_changed("master.slaves", slaves): log("Slaves are unchanged - no need to do anything") return api = Api() for slave in slaves: api.add_node(slave["slavehost"], slave["executors"], labels=slave["labels"] or ())
def departed(self): """Indicate the relation is no longer available and not connected.""" # Slave hostname is derived from unit name so # this is pretty safe slavehost = remote_unit() log("Deleting slave with hostname %s." % slavehost) api = Api() api.delete_node(slavehost.replace("/", "-")) self.remove_state("{relation_name}.available") self.remove_state("{relation_name}.connected")
def changed(self): """Install optional plugins.""" # extension subordinates may request the principle service install # specified jenkins plugins log("Installing required plugins as requested by jenkins-extension " "subordinate.") plugins = Plugins() plugins.install(relation_get("required_plugins")) api = Api() api.wait() # Wait for the service to be fully up
def broken(self): """Indicate the relation is no longer available and not connected.""" api = Api() for member in relation_ids(): member = member.replace("/", "-") log("Removing node %s from Jenkins master." % member) api.delete_node(member) self.remove_state("{relation_name}.available") self.remove_state("{relation_name}.connected") self.remove_state("{relation_name}.tls.available")
def upgrade_jenkins(): if config("release") == "bundle": packages = Packages() if packages.jenkins_upgradable(): status_set("maintenance", "Upgrading Jenkins") packages.install_jenkins() api = Api() api.wait() # Wait for the upgrade to finish packages.clean_old_plugins() unitdata.kv().set("jenkins.plugins.last_update", 0) update_plugins() else: log("No newer jenkins package is available")
def _install_plugin(self, plugin, plugins_site, update): """ Verify if the plugin is not installed before installing it or if it needs an update . """ plugin_version = Api().get_plugin_version(plugin) latest_version = self._get_latest_version(plugin) if not plugin_version or (update and plugin_version != latest_version): hookenv.log("Installing plugin %s-%s" % (plugin, latest_version)) plugin_url = ("%s/%s.hpi" % (plugins_site, plugin)) return self._download_plugin(plugin, plugin_url) hookenv.log("Plugin %s-%s already installed" % (plugin, plugin_version))
def configure_plugins(): if get_state("extension.connected"): # We've been driven by an extension, let it take control over # plugin. log("External relation detected - skip configuring plugins") return status_set("maintenance", "Configuring plugins") remove_state("jenkins.configured.plugins") plugins = Plugins() plugins.install(config("plugins")) api = Api() api.wait() # Wait for the service to be fully up set_state("jenkins.configured.plugins")
def update_plugins(): last_update = unitdata.kv().get("jenkins.plugins.last_update") if last_update is None: unitdata.kv().set("jenkins.plugins.last_update", 0) last_update = 0 # Only try to update plugins when the interval configured has passed update_interval = time.time() - (config("plugins-auto-update-interval") * 60) if (last_update < update_interval): status_set("maintenance", "Updating plugins") plugins = Plugins() plugins.update(config("plugins")) api = Api() api.wait() # Wait for the service to be fully up unitdata.kv().set("jenkins.plugins.last_update", time.time())
def configure_admin(): remove_state("jenkins.configured.admin") status_set("maintenance", "Configuring admin user") users = Users() users.configure_admin() api = Api() api.reload() api.wait() # Wait for the service to be fully up # Inform any extension that the username/password changed if get_state("extension.connected"): extension_relation = (RelationBase.from_state("extension.connected")) extension_relation.joined() set_state("jenkins.configured.admin")
def update_nrpe_config(nagios): unit_data = unitdata.kv() nagios_hostname = unit_data.get('nagios.hostname', None) nagios_host_context = unit_data.get('nagios.host_context', None) # require the nrpe-external-master relation to provide the host context if in_relation_hook() and relation_id().\ startswith('nrpe-external-master:'): rel = relation_get() if 'nagios_host_context' in rel: nagios_host_context = rel['nagios_host_context'] unit_data.set('nagios.host_context', nagios_host_context) # We have to strip the nagios host context from the nagios hostname # since the nagios.add_check will put it back again... nagios_hostname = rel['nagios_hostname'] if nagios_hostname.startswith(nagios_host_context + '-'): nagios_hostname = nagios_hostname[len(nagios_host_context + '-'):] unit_data.set('nagios.hostname', nagios_hostname) if not nagios_hostname or not nagios_host_context: return # The above boilerplate is needed until this issue is fixed: # # https://github.com/cmars/nrpe-external-master-interface/issues/6 status_set('maintenance', 'Updating Nagios configs') creds = Credentials() check = [ '/usr/lib/nagios/plugins/check_http', '-H', 'localhost', '-p', '8080', '-u', urlparse(Api().url).path, '-a', "{}:{}".format(creds.username(), creds.token()), ] nagios.add_check(check, name="check_jenkins_http", description="Verify Jenkins HTTP is up.", context=nagios_host_context, unit=nagios_hostname) status_set('active', 'Ready')
def test_check_ready_transient_failure(self): """ Transient failures are retried. """ start = time.time() def callback(requests, context): if time.time() - start >= 2: context.status_code = 503 else: context.status_code = 200 return "" api = Api() self.fakes.network.get(api.url, text=callback) self.assertIsNone(self.service.check_ready())
def _setUp(self): self.fakes.users.add("jenkins", 123) self.fakes.groups.add("nogroup", 456) self.fakes.fs.add(paths.HOME) os.makedirs(paths.SECRETS) with open(paths.INITIAL_PASSWORD, "w") as fd: fd.write(INITIAL_PASSWORD) self.fakes.fs.add(paths.DEFAULTS_CONFIG_FILE) os.makedirs('/etc/default') with open(paths.DEFAULTS_CONFIG_FILE, "wb") as fd: fd.write(b"# port for HTTP connector\nHTTP_PORT=8080\n") fd.write(b'JENKINS_ARGS="--httpPort=$HTTP_PORT"') api = Api() self.fakes.network.get(api.url, headers={"X-Jenkins": "2.0.0"})
def configure_proxy(self): """Check whether the machine is configured to use an http(s) proxy and if it does - propagate the environment proxy settings to Jenkins.""" env_proxy = (os.environ['HTTP_PROXY'] or os.environ['HTTPS_PROXY'] or os.environ['http_proxy'] or os.environ['https_proxy']) if not env_proxy: hookenv.log("There are no environment proxy settings") return hookenv.log("There are environment proxy settings") url = urlparse(env_proxy) noproxy = os.environ['NO_PROXY'] or os.environ['no_proxy'] if noproxy: noproxy = ' '.join( [re.sub("^\.", '*.', x.strip()) for x in noproxy.split(',')]) api = Api() api.configure_proxy(url.hostname, url.port, url.username, url.password, noproxy)
def update(self, plugins): """Try to update the given plugins. @params plugins: A whitespace-separated list of plugins to install. """ plugins = plugins or "" plugins = plugins.split() plugins = self._get_plugins_to_install(plugins) hookenv.log("Updating plugins") try: installed_plugins = self._install_plugins(plugins) except Exception: hookenv.log("Plugin update failed, check logs for details") raise if len(installed_plugins) == 0: hookenv.log("No plugins updated") return else: Api().restart() return installed_plugins
def update_plugins(): last_update = unitdata.kv().get("jenkins.plugins.last_update") if last_update is None: unitdata.kv().set("jenkins.plugins.last_update", 0) last_update = 0 # Only try to update plugins when the interval configured has passed update_interval = time.time() - (config("plugins-auto-update-interval") * 60) if (last_update < update_interval): status_set("maintenance", "Updating plugins") remove_state("jenkins.updated.plugins") plugins = Plugins() plugins.update(config("plugins")) api = Api() api.wait() # Wait for the service to be fully up # Restart jenkins if any plugin got updated last_restart = unitdata.kv().get("jenkins.last_restart") or 0 last_plugin_update_time = ( unitdata.kv().get("jenkins.plugins.last_plugin_update_time") or 0) if (last_restart < last_plugin_update_time): restart() unitdata.kv().set("jenkins.plugins.last_restart", time.time()) set_state("jenkins.updated.plugins") unitdata.kv().set("jenkins.plugins.last_update", time.time())
def check_ready(self): """Build a Jenkins client instance.""" api = Api() response = requests.get(api.url) if response.status_code >= 500: raise ServiceUnavailable()
def setUp(self): super(ApiTest, self).setUp() self.useFixture(JenkinsConfiguredAdmin(self.fakes)) self.fakes.jenkins.scripts[GET_TOKEN_SCRIPT.format("admin")] = "abc\n" self.api = Api()
def restart(): api = Api() api.restart() api.wait() # Wait for the service to be fully up unitdata.kv().set("jenkins.last_restart", time.time())