lib/puppet/type/vcsrepo.rb

   1 require 'pathname'
   2
   3 Puppet::Type.newtype(:vcsrepo) do
   4   desc "A local version control repository"
   5
   6   feature :gzip_compression,
   7           "The provider supports explicit GZip compression levels"
   8   feature :basic_auth,
   9           "The provider supports HTTP Basic Authentication"
  10   feature :bare_repositories,
  11           "The provider differentiates between bare repositories
  12           and those with working copies",
  13           :methods => [:bare_exists?, :working_copy_exists?]
  14
  15   feature :filesystem_types,
  16           "The provider supports different filesystem types"
  17
  18   feature :reference_tracking,
  19           "The provider supports tracking revision references that can change
  20            over time (eg, some VCS tags and branch names)"
  21
  22   feature :ssh_identity,
  23           "The provider supports a configurable SSH identity file"
  24
  25   feature :user,
  26           "The provider can run as a different user"
  27
  28   feature :modules,
  29           "The repository contains modules that can be chosen of"
  30
  31   feature :multiple_remotes,
  32           "The repository tracks multiple remote repositories"
  33
  34   feature :configuration,
  35           "The configuration directory to use"
  36
  37   feature :cvs_rsh,
  38           "The provider understands the CVS_RSH environment variable"
  39
  40   feature :depth,
  41           "The provider can do shallow clones or set scope limit"
  42
  43   feature :branch,
  44           "The name of the branch"
  45
  46   feature :p4config,
  47           "The provider understands Perforce Configuration"
  48
  49   feature :submodules,
  50           "The repository contains submodules which can be optionally initialized"
  51
  52   feature :conflict,
  53           "The provider supports automatic conflict resolution"
  54
  55   ensurable do
  56     attr_accessor :latest
  57
  58     def insync?(is)
  59       @should ||= []
  60
  61       case should
  62       when :present
  63         return true unless [:absent, :purged, :held].include?(is)
  64       when :latest
  65         if is == :latest
  66           return true
  67         else
  68           return false
  69         end
  70       when :bare
  71         return is == :bare
  72       end
  73     end
  74
  75     newvalue :present do
  76       notice "Creating repository from present"
  77       provider.create
  78     end
  79
  80     newvalue :bare, :required_features => [:bare_repositories] do
  81       if !provider.exists?
  82         provider.create
  83       end
  84     end
  85
  86     newvalue :absent do
  87       provider.destroy
  88     end
  89
  90     newvalue :latest, :required_features => [:reference_tracking] do
  91       if provider.exists? && !@resource.value(:force)
  92         if provider.respond_to?(:update_references)
  93           provider.update_references
  94         end
  95         if provider.respond_to?(:latest?)
  96             reference = provider.latest || provider.revision
  97         else
  98           reference = resource.value(:revision) || provider.revision
  99         end
 100         notice "Updating to latest '#{reference}' revision"
 101         provider.revision = reference
 102       else
 103         notice "Creating repository from latest"
 104         provider.create
 105       end
 106     end
 107
 108     def retrieve
 109       prov = @resource.provider
 110       if prov
 111         if prov.working_copy_exists?
 112           (@should.include?(:latest) && prov.latest?) ? :latest : :present
 113         elsif prov.class.feature?(:bare_repositories) and prov.bare_exists?
 114           :bare
 115         else
 116           :absent
 117         end
 118       else
 119         raise Puppet::Error, "Could not find provider"
 120       end
 121     end
 122
 123   end
 124
 125   newparam :path do
 126     desc "Absolute path to repository"
 127     isnamevar
 128     validate do |value|
 129       path = Pathname.new(value)
 130       unless path.absolute?
 131         raise ArgumentError, "Path must be absolute: #{path}"
 132       end
 133     end
 134   end
 135
 136   newparam :source do
 137     desc "The source URI for the repository"
 138   end
 139
 140   newparam :fstype, :required_features => [:filesystem_types] do
 141     desc "Filesystem type"
 142   end
 143
 144   newproperty :revision do
 145     desc "The revision of the repository"
 146     newvalue(/^\S+$/)
 147   end
 148
 149   newparam :owner do
 150     desc "The user/uid that owns the repository files"
 151   end
 152
 153   newparam :group do
 154     desc "The group/gid that owns the repository files"
 155   end
 156
 157   newparam :user do
 158     desc "The user to run for repository operations"
 159   end
 160
 161   newparam :excludes do
 162     desc "Files to be excluded from the repository"
 163   end
 164
 165   newparam :force do
 166     desc "Force repository creation, destroying any files on the path in the process."
 167     newvalues(:true, :false)
 168     defaultto false
 169   end
 170
 171   newparam :compression, :required_features => [:gzip_compression] do
 172     desc "Compression level"
 173     validate do |amount|
 174       unless Integer(amount).between?(0, 6)
 175         raise ArgumentError, "Unsupported compression level: #{amount} (expected 0-6)"
 176       end
 177     end
 178   end
 179
 180   newparam :basic_auth_username, :required_features => [:basic_auth] do
 181     desc "HTTP Basic Auth username"
 182   end
 183
 184   newparam :basic_auth_password, :required_features => [:basic_auth] do
 185     desc "HTTP Basic Auth password"
 186   end
 187
 188   newparam :identity, :required_features => [:ssh_identity] do
 189     desc "SSH identity file"
 190   end
 191
 192   newparam :module, :required_features => [:modules] do
 193     desc "The repository module to manage"
 194   end
 195
 196   newparam :remote, :required_features => [:multiple_remotes] do
 197     desc "The remote repository to track"
 198     defaultto "origin"
 199   end
 200
 201   newparam :configuration, :required_features => [:configuration]  do
 202     desc "The configuration directory to use"
 203   end
 204
 205   newparam :cvs_rsh, :required_features => [:cvs_rsh] do
 206     desc "The value to be used for the CVS_RSH environment variable."
 207   end
 208
 209   newparam :depth, :required_features => [:depth] do
 210     desc "The value to be used to do a shallow clone."
 211   end
 212
 213   newparam :branch, :required_features => [:branch] do
 214     desc "The name of the branch to clone."
 215   end
 216
 217   newparam :p4config, :required_features => [:p4config] do
 218     desc "The Perforce P4CONFIG environment."
 219   end
 220
 221   newparam :submodules, :required_features => [:submodules] do
 222     desc "Initialize and update each submodule in the repository."
 223     newvalues(:true, :false)
 224     defaultto true
 225   end
 226
 227   newparam :conflict do
 228     desc "The action to take if conflicts exist between repository and working copy"
 229   end
 230
 231   newparam :trust_server_cert do
 232     desc "Trust server certificate"
 233     newvalues(:true, :false)
 234     defaultto false
 235   end
 236
 237   autorequire(:package) do
 238     ['git', 'git-core', 'mercurial']
 239   end
 240 end