Add "basic" support for OpenBSD. #304

buzzdeee · 2015-05-18T18:28:33Z

Support only "basic", since a few things are untested, and known to not work (yet).

What works and is tested:

installation via package
jenkins service management
plugins_string fact and therefore plugin management

What is definately not working:

jenkins::cli (jar is not in the PATH), I have to "enhance"
puppetlabs/java before that, to add a fact pointing to the right
directory, or add another variable to params.pp ;)

Otherwise untested:

jobs management
jenkins slave configuration

Some changes had to be done to the params.pp. Some information that
were hard-coded before, are now OS dependent set there. For all the
other OS, kept as it was there already, or somewhere else hard-coded.

On OpenBSD, and other *BSD, there is no group 'root', therefore, whereever
access permissions for a 'root' group were made, changed it to the gid of '0'

The jenkins system user and group are '_jenkins', therefore added these
as variables. Jenkins users home directory is /var/jenkins, instead of the
otherwise hardcoded /var/lib/jenkins, and further, jenkins is installed
in /var/lib/jenkins/.jenkins.

Because of above facts, most changes to manifests/plugins.pp, because the
plugin_parent_dir assumption, that this is the same as the jenkins users
home directory is not true on OpenBSD. Also, wget is available as package,
but installed in /usr/local/bin. Therefore added this to the path for the command.

Further, made repo management OS dependent, and for OpenBSD, set the value
to false.

Services on OpenBSD get configured via flags to the OpenBSD service provider.
Since I had seen problems with older Puppet versions, manifests/services got
a little bit enhanced, to only make use of that flag, when on OpenBSD.

Last but not least, a bunch of specs added here and there, to reflect OpenBSD.

Tested on OpenBSD amd64 with Puppet 3.7.4, jenkins-1.605 and jenkins-1.596.1, that is all available as packages.

haven't added OpenBSD to metadata.json, due to above mentioned bits that are not (yet ;) supported.

Hope that all that makes sense, and can be merged. Let me know if there is something that needs clarification, or changes or whatnot, and I'll be happy to work on it.

cheers.

jenkinsadmin · 2015-05-19T00:02:09Z

Thank you for a pull request! Please check this document for how the Jenkins project handles pull requests

jhoblitt · 2015-05-19T03:13:06Z

manifests/params.pp

+      $repo             = true
+      $homedir          = '/var/lib/jenkins'
+      $jenkinsdir       = $homedir
+      $default_plugin_dir = "${jenkinsdir}/plugins"


Might be worth lining up the indenting even though the linter won't complain about it.

buzzdeee · 2015-05-19T09:40:38Z

I think I addressed all of your comments, Travis is still green, and it still seems to work for me ;)
let me know if there is more.
Commits squashed again.

buzzdeee · 2015-06-11T08:49:03Z

rebased for your convenience

matthewbarr · 2015-07-14T14:55:14Z

manifests/service.pp

+        service { 'jenkins':
+          ensure     => $jenkins::service_ensure,
+          enable     => $jenkins::service_enable,
+          flags      => $jenkins::service_flags,


Why does this need to be it's own case? If flags is empty, it'll be fine, iirc.

I had run into trouble with a different module I made aware of those flags. Short after merge upstream, someone who ran an older version of PE complained. That version he ran, I don't remember, wasn't aware of the flags parameterr to the service, and bailed out. Therefore the two cases here, If you don't care, I can have it without the case statement ;)

petems · 2015-07-14T15:00:02Z

@buzzdeee There's upcoming OpenBSD support in Beaker (voxpupuli/beaker#812) so there might be the option to add a beaker spec for this when it gets merged! 👍

jhoblitt · 2015-07-14T15:31:33Z

manifests/init.pp

@@ -41,12 +41,17 @@
 # service_ensure = 'running' (default)
 #   Status of the jenkins service.  running, stopped
 #
+# service_flags = undef (default)
+#   Service parameters for the jenkins service on OpenBSD, string, see daemon_flags
+#   in /etc/rc.d/jenkins for an example.


Is there supposed to be a template for /etc/rc.d/jenkins?

nope, OpenBSD jenkins package comes with a well working rc script, see: http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/ports/devel/jenkins/pkg/jenkins.rc?rev=1.6&content-type=text/plain

petems · 2015-07-14T21:32:49Z

@buzzdeee Got a working OpenBSD Beaker test 💃 :

require 'spec_helper_acceptance'

describe 'jenkins class on OpenBSD', :if => fact('osfamily') == 'OpenBSD' do

  before(:all) do
    shell('rm -rf /etc/puppet/modules/java')
    shell('pkg_add -I git')
    shell('git clone https://github.com/puppetlabs/puppetlabs-java /etc/puppet/modules/java')

    pkg_conf_pp = <<-EOS

    $source = "http://ftp3.usa.openbsd.org/pub/OpenBSD/${::kernelmajversion}/packages/${::architecture}/"

    file { '/etc/pkg.conf':
      ensure  => file,
      owner   => 'root',
      group   => 'wheel',
      mode    => '0644',
      content => "# OpenBSD pkg.conf\ninstallpath=${source}\n",
    }
  EOS

    apply_manifest(pkg_conf_pp, :catch_failures => true)
  end

  context 'default parameters' do
    it 'should work with no errors' do
      pp = <<-EOS
      class {'jenkins':}
      EOS

      # Run it twice and test for idempotency
      apply_manifest(pp, :catch_failures => true)
      apply_manifest(pp, :catch_changes => true)
    end

    describe port(8000) do
      it {
        sleep(10) # Jenkins takes a while to start up
        should be_listening
      }
    end

    describe service('jenkins') do
      it { should be_running }
    end

  end
end

buzzdeee · 2015-07-14T21:52:48Z

@petems, for the $source in the beaker test you might want to use:
"http://ftp.openbsd.org/pub/OpenBSD/${::kernelmajversion}/packages/${::hardwareisa}/"

so ::hardwareisa instead of ::architecture, There are architectures/platforms, that differ, i.e. macppc/powerpc, and a few others.
Anyways, since Jenkins is java based, and java is only for i386 and amd64, both are safe ;)

Do you want me to integrate that? Haven't used beaker before, so it would not incredibly easy to test for me ;)

cheers,

petems · 2015-07-15T10:06:57Z

@buzzdeee I can pull it in as a separate PR 👍

petems · 2015-07-15T10:12:33Z

See #342

buzzdeee · 2015-07-15T14:10:15Z

that's fine with me, thanks!
BTW, that failed travis-ci build, just needs to be restarted. I also got some odd failings on my repo when I updated and pushed changes, usually a restart helped to do tests in different random order, and all went green.

I kept the large number of changes for the time being, for the case you want to see better what I did. I can squash/rebase whenever necessary or wanted.

buzzdeee · 2015-07-15T14:14:43Z

manifests/plugin.pp

+  $jplugin_dir = $plugin_dir ? {
+    ''      => $::jenkins::params::plugin_dir,
+    default => $plugin_dir,
+  }


I had to do above dance with the parameters,
I just tried to pull in $plugin_dir = $::jenkins::params::plugin_dir
and also the others, in the parameter list of the defined type, but then all the time, the tests failed. It seemed that Puppet didn't pulled that info in at that time.

I had to set the default values for the parameters to '', because the selector didn't wanted to work when they were set to undef.

Alternatively, I could set these variables default to undef and do check like:

if $plugin_dir {
$jplugin_dir = $plugin_dir
} else {
$jplugin_dir = $::jenkins::params::plugin_dir
}

if that is preferred, or let me know if there is a better way to work around that.

A :pre_condition block that pulls in jenkins/jenkins::paramswould likely be needed for those tests to work. However, that would introduce evaluation order dependent behavior for users. My opinion is that introducing parse order requirements at this point would be a major API break.

Unlike the inherits hack that works for classes, there's no way [that I'm aware of] internal to a defined type to require that a class be evaluated before it in the manifest. It can be done external to the define by placing constraints using resource collectors (which have side effects on virtual resources) or if you know the name of the define. I used the later approach in my selenium module. Eg., https://github.com/jhoblitt/puppet-selenium/blob/master/manifests/hub.pp#L14-L23 Which isn't exposed to the user as its wrapped up in a class. I think the if/else approach you've described or a custom function is the most robust approach.

I figured that I can do something like:

define jenkins::plugin (
foo,
) {
Class['jenkins::params'] ->
Jenkins::Plugin[$name]
}

to ensure that the jenkins::params are evaluated before the define.

See PR #356 , first start of to configure the user/group in params.pp

jhoblitt · 2015-07-22T16:23:24Z

@buzzdeee I'd like to suggest that you try to split all of the non-specific to openbsd values out of this branch and create a new PR for it. I think there's some valuable house keeping in this PR, in particular having a canonical value for the jenkins user/group, that should be fairly straight forward to merge. That should ultimately make it easier to keep this PR rebased on the current master.

buzzdeee · 2015-07-24T07:03:17Z

I'll see what I can do to split off the PR into multiple, just need to find the time, hopefully on the weekend, or next week.

jhoblitt · 2015-10-13T04:35:39Z

@buzzdeee I think if you rebase upon the current master this will be a much smaller PR now.

buzzdeee · 2015-10-13T09:26:41Z

yay, will hopefully find time this week

cheers,

olevole · 2016-07-29T10:51:59Z

Any update for this Issue ? I'm interesting in OpenBSD and FreeBSD support

Jenkins installed via the jenkins package is a bit different on OpenBSD than on other Linux that were supported so far. Major differences: * jenkins system user/group is called _jenkins * jenkins users home directory is /var/jenkins, but the state and everything related to Jenkins is stored under /var/jenkins/.jenkins, i.e. /var/jenkins/.jenksin/plugins Therefore following changes: lib/puppet/jenkins.rb * figure out the jenkins home_dir based on the _jenkins user * point the plugins_dir to $home_dir/.jenkins/plugins lib/puppet/jenkins/facts.rb * confine the jenkins_plugins fact to OpenBSD too manifests/init.pp * add a service_flags parameter, to hand over flags for the jenkins service * while there, remove some redundant documentation of user/group parameters manifests/params.pp * make $user, $group, and $localstatedir dependent on ::osfamily * add a $jarbin variable, pointing to the Java jar binary, for all but OpenBSD, use the short name: 'jar', for OpenBSD, default to the full path where it can be found, overridable via parameter to init.pp * similarily to the $jarbin, add a $javabin variable and use it manifests/repo.pp * add an empty case for OpenBSD, no special handling required jenkins package is in default repos available manifests/service.pp * add a special case for OpenBSD to manage the service. This is necessary, because I've seen with other puppet modules, supporting older puppet versions, that the service_flags parameter might not be understood when it is given. manifests/cli/config.pp * do not hardcode the jenkins user and group * use the $::jenkins::jarbin variable, in order to find the Java jar binary manifests/cli.pp * make use of the $javabin variable instead of hardcoding the java binary manifests/cli_helper.pp * make use of the $javabin variable instead of hardcoding the java binary specs/* * rearrange/add some specs to handle tests for OpenBSD Add javabin parameter, and use it where java binary is used

of the cli tools that take info from the config_hash to find the jenkins port Fixup localstatedir for OpenBSD, point to .jenkins subdir rubocop pleasings

Closes voxpupuli#304

bastelfreak · 2019-05-11T15:01:12Z

Hi people. This PR is pretty huge and got quite some feedback. But since it got stalled, I'm going to close it. If anybody is still interested in it, please reopen/resubmit it and rebase.

jhoblitt reviewed May 19, 2015
View reviewed changes

matthewbarr reviewed Jul 14, 2015
View reviewed changes

jhoblitt reviewed Jul 14, 2015
View reviewed changes

buzzdeee reviewed Jul 15, 2015
View reviewed changes

buzzdeee mentioned this pull request Aug 10, 2015

Make the jenkins system user and group OS dependent. #356

Closed

jhoblitt mentioned this pull request Oct 11, 2015

add user/group mgt. + localstatedir params to jenkins class #396

Merged

jhoblitt added the enhancement New feature or request label Oct 12, 2015

jhoblitt added the needs-rebase label Oct 12, 2015

buzzdeee added 4 commits July 29, 2016 15:40

Add case for OpenBSD to the sysconfig.pp, needed for now, because

de59933

of the cli tools that take info from the config_hash to find the jenkins port Fixup localstatedir for OpenBSD, point to .jenkins subdir rubocop pleasings

try fix

30cb78b

default javabin in params is java, not /usr/bin/java

2c04250

rtyler pushed a commit to rtyler/puppet-jenkins that referenced this pull request Oct 21, 2016

Refactor some tests to allow OpenBSD support to pass

1a67a90

Closes voxpupuli#304

rtyler mentioned this pull request Oct 21, 2016

Add "basic" OpenBSD support #658

Closed

rtyler pushed a commit to rtyler/puppet-jenkins that referenced this pull request Nov 1, 2016

Refactor some tests to allow OpenBSD support to pass

af537af

Closes voxpupuli#304

olevole mentioned this pull request Apr 6, 2017

Initial FreeBSD support #743

Closed

esalberg mentioned this pull request Feb 20, 2018

semi-regular triage/use case discussions? #857

Closed

bastelfreak closed this May 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "basic" support for OpenBSD. #304

Add "basic" support for OpenBSD. #304

buzzdeee commented May 18, 2015

jenkinsadmin commented May 19, 2015

jhoblitt May 19, 2015

buzzdeee commented May 19, 2015

buzzdeee commented Jun 11, 2015

matthewbarr Jul 14, 2015

buzzdeee Jul 14, 2015

petems commented Jul 14, 2015

jhoblitt Jul 14, 2015

buzzdeee Jul 14, 2015

petems commented Jul 14, 2015

buzzdeee commented Jul 14, 2015

petems commented Jul 15, 2015

petems commented Jul 15, 2015

buzzdeee commented Jul 15, 2015

buzzdeee Jul 15, 2015

jhoblitt Jul 22, 2015

buzzdeee Aug 10, 2015

jhoblitt commented Jul 22, 2015

buzzdeee commented Jul 24, 2015

jhoblitt commented Oct 13, 2015

buzzdeee commented Oct 13, 2015

olevole commented Jul 29, 2016

bastelfreak commented May 11, 2019

Add "basic" support for OpenBSD. #304

Add "basic" support for OpenBSD. #304

Conversation

buzzdeee commented May 18, 2015

jenkinsadmin commented May 19, 2015

Choose a reason for hiding this comment

buzzdeee commented May 19, 2015

buzzdeee commented Jun 11, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petems commented Jul 14, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petems commented Jul 14, 2015

buzzdeee commented Jul 14, 2015

petems commented Jul 15, 2015

petems commented Jul 15, 2015

buzzdeee commented Jul 15, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhoblitt commented Jul 22, 2015

buzzdeee commented Jul 24, 2015

jhoblitt commented Oct 13, 2015

buzzdeee commented Oct 13, 2015

olevole commented Jul 29, 2016

bastelfreak commented May 11, 2019