ec40cf34e014a268e9f090f19c98dca4646793cb
[puppet_vcsrepo.git] / lib / puppet / provider / vcsrepo / p4.rb
1 require File.join(File.dirname(__FILE__), '..', 'vcsrepo')
2
3 Puppet::Type.type(:vcsrepo).provide(:p4, :parent => Puppet::Provider::Vcsrepo) do
4   desc "Supports Perforce depots"
5
6   has_features :filesystem_types, :reference_tracking, :p4config
7   
8   def create
9     # create or update client 
10     create_client(client_name, @resource.value(:path))
11     
12     # if source provided, sync client
13     source = @resource.value(:source)
14     if source
15       revision = @resource.value(:revision)
16       sync_client(source, revision)
17     end
18
19     update_owner
20   end
21
22   def working_copy_exists?
23     # Check if the server is there, or raise error
24     p4(['info'], {:marshal => false})
25   
26     # Check if workspace is setup
27     args = ['where']
28     args.push(@resource.value(:path) + "...")
29     hash = p4(args, {:raise => false})
30     
31     return (hash['code'] != "error")
32   end
33
34   def exists?
35     working_copy_exists?
36   end
37
38   def destroy
39     args = ['client']
40     args.push('-d', '-f')
41     args.push(client_name)
42     p4(args)
43     FileUtils.rm_rf(@resource.value(:path))
44   end
45
46   def latest?
47     rev = self.revision
48     if rev
49       (rev >= self.latest)
50     else
51       true
52     end   
53   end
54
55   def latest
56     args = ['changes']
57     args.push('-m1', @resource.value(:source))
58     hash = p4(args)
59     
60     return hash['change'].to_i
61   end
62
63   def revision
64     args = ['cstat']
65     args.push(@resource.value(:source))
66     hash = p4(args)
67     
68     if hash['status'] == "have"
69       return hash['change'].to_i
70     else
71       return 0
72     end
73   end
74
75   def revision=(desired)
76     sync_client(@resource.value(:source), desired)
77     update_owner
78   end
79
80   private
81
82   def update_owner
83     if @resource.value(:owner) or @resource.value(:group)
84       set_ownership
85     end
86   end
87   
88   # Sync the client workspace files to head or specified revision.
89   # Params:
90   # +source+:: Depot path to sync
91   # +revision+:: Perforce change list to sync to (optional)
92   def sync_client(source, revision)
93     Puppet.debug "Syncing: #{source}"
94     args = ['sync']
95     if revision
96       args.push(source + "@" + revision)
97     else
98       args.push(source)
99     end
100     p4(args)
101   end
102   
103   # Returns the name of the Perforce client workspace 
104   def client_name
105     p4config = @resource.value(:p4config)
106     
107     # default (generated) client name
108     path = @resource.value(:path)
109     default = "puppet-" + Digest::MD5.hexdigest(path)
110     
111     # check config for client name
112     set_client = nil
113     if p4config && File.file?(p4config)
114       open(p4config) do |f|
115         m = f.grep(/^P4CLIENT=/).pop
116         p = /^P4CLIENT=(.*)$/
117         set_client = p.match(m)[1] if m
118       end
119     end
120   
121     return set_client || ENV['P4CLIENT'] || default
122   end
123   
124   # Create (or update) a client workspace spec.
125   # If a client name is not provided then a hash based on the path is used.
126   # Params:
127   # +client+:: Name of client workspace
128   # +path+:: The Root location of the Perforce client workspace
129   def create_client(client, path)
130     Puppet.debug "Creating client: #{client}"
131     hash = parse_client(client)
132     hash['Root'] = path
133     hash['Description'] = "Generated by Puppet VCSrepo"
134     save_client(hash)
135   end
136
137
138   # Fetches a client workspace spec from Perforce and returns a hash map representation.
139   # Params:
140   # +client+:: name of the client workspace
141   def parse_client(client)
142     args = ['client']
143     args.push('-o', client)
144     hash = p4(args)
145
146     return hash
147   end
148   
149   
150   # Saves the client workspace spec from the given hash 
151   # Params:
152   # +hash+:: hash map of client spec
153   def save_client(hash)
154     spec = String.new
155     view = "\nView:\n"
156   
157     hash.each do |k,v|
158       next if( k == "code" )
159       if(k.to_s =~ /View/ )
160         view += "\t#{v}\n"
161       else
162         spec += "#{k.to_s}: #{v.to_s}\n"
163       end
164     end 
165     spec += view
166     
167     args = ['client']
168     args.push('-i')
169     p4(args, {:input => spec, :marshal => false})
170   end 
171   
172   # Sets Perforce Configuration environment.
173   # P4CLIENT generated, but overwitten if defined in config.
174   def config
175     p4config = @resource.value(:p4config)
176     
177     cfg = Hash.new
178     cfg.store 'P4CONFIG', p4config if p4config
179     cfg.store 'P4CLIENT', client_name
180     return cfg  
181   end
182   
183   def p4(args, options = {})
184     # Merge custom options with defaults
185     opts = { 
186       :raise    => true,    # Raise errors
187       :marshal  => true,    # Marshal output
188     }.merge(options)
189     
190     cmd = ['p4']
191     cmd.push '-R' if opts[:marshal]
192     cmd.push args
193     cmd_str = cmd.respond_to?(:join) ? cmd.join(' ') : cmd
194     
195     Puppet.debug "environment: #{config}"
196     Puppet.debug "command: #{cmd_str}"
197     
198     hash = Hash.new
199     Open3.popen3(config, cmd_str) do |i, o, e, t|
200       # Send input stream if provided
201       if(opts[:input])
202         Puppet.debug "input:\n" + opts[:input]
203         i.write opts[:input]
204         i.close
205       end
206       
207       if(opts[:marshal])
208         hash = Marshal.load(o)
209       else
210         hash['data'] = o.read       
211       end
212       
213       # Raise errors, Perforce or Exec
214       if(opts[:raise])
215         p4_err = "P4: " + hash['data'] if(hash['code'] == 'error') 
216         raise Puppet::DevError, "#{p4_err}\n#{e.read}\nExit: #{t.value}" if(t.value != 0)
217       end
218     end
219     
220     Puppet.debug "hash: #{hash}\n"
221     return hash
222   end
223   
224 end