Module: Capistrano::SBT

Defined in:
lib/capistrano-sbt.rb,
lib/capistrano-sbt/version.rb

Constant Summary collapse

VERSION =
"0.1.2"

Class Method Summary collapse

Class Method Details

.extended(configuration) ⇒ Object



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/capistrano-sbt.rb', line 10

def self.extended(configuration)
  configuration.load {
    namespace(:sbt) {
      _cset(:sbt_roles, [:app])
      _cset(:sbt_tools_path) { File.join(shared_path, "tools", "sbt") }
      _cset(:sbt_tools_path_local) { File.expand_path("tools/sbt") }
      _cset(:sbt_archive_path) { sbt_tools_path }
      _cset(:sbt_archive_path_local) { sbt_tools_path_local }
      _cset(:sbt_path) {
        if sbt_use_extras
          File.join(sbt_tools_path, "sbt-extras")
        else
          File.join(sbt_tools_path, "sbt-#{sbt_version}")
        end
      }
      _cset(:sbt_path_local) {
        if sbt_use_extras
          File.join(sbt_tools_path_local, "sbt-extras")
        else
          File.join(sbt_tools_path_local, "sbt-#{sbt_version}")
        end
      }
      _cset(:sbt_bin_path) { sbt_path }
      _cset(:sbt_bin_path_local) { sbt_path_local }
      _cset(:sbt_bin) { File.join(sbt_bin_path, "sbt") }
      _cset(:sbt_bin_local) { File.join(sbt_bin_path_local, "sbt") }
      _cset(:sbt_project_path) { release_path }
      _cset(:sbt_project_path_local) { File.expand_path(".") }
      _cset(:sbt_target_path) { File.join(sbt_project_path, "target") }
      _cset(:sbt_target_path_local) { File.join(sbt_project_path_local, "target") }
      _cset(:sbt_template_path) { File.expand_path("config/templates") }

      ## sbt-extras
      _cset(:sbt_use_extras, true)
      _cset(:sbt_extras_url, "https://raw.github.com/paulp/sbt-extras/master/sbt")
      _cset(:sbt_extras_file) { File.join(sbt_tools_path, "sbt") }
      _cset(:sbt_extras_file_local) { File.join(sbt_tools_path_local, "sbt") }
      _cset(:sbt_extras_update_interval) {
        if exists?(:sbt_extras_check_interval)
          logger.info(":sbt_extras_check_interval has been deprecated. use :sbt_extras_update_interval instead.")
          fetch(:sbt_extras_check_interval)
        else
          86400
        end
      }
      _cset(:sbt_extras_update_timestamp) { (Time.now - sbt_extras_update_interval).strftime("%Y%m%d%H%M") }

      ## sbt-launch.jar
      _cset(:sbt_project_sbt_version) {
        begin
          tempfile = Tempfile.new("capistrano-sbt")
          download(File.join(sbt_project_path, "project", "build.properties"), tempfile.path)
          tempfile.rewind()
          tempfile.read().scan(/^sbt\.version=(.*)$/).map { |x| x.last }.last
        rescue
          nil
        ensure
          tempfile.close()
        end
      }
      _cset(:sbt_project_sbt_version_local) {
        begin
          properties = File.read(File.join(sbt_project_path_local, "project", "build.properties"))
          properties.scan(/^sbt\.version=(.*)$/).map { |x| x.last }.last
        rescue
          nil
        end
      }
      _cset(:sbt_version) {
        version ||= sbt_project_sbt_version if sbt_update_remotely
        version ||= sbt_project_sbt_version_local if sbt_update_locally
        version ||= "0.12.2"
        logger.debug("Detected sbt version #{version}")
        version
      }
      _cset(:sbt_group_id) {
        case sbt_version
        when /^0\.(?:7|10)\.\d+$/, /^0\.11\.[0-2]$/
          "org.scala-tools.sbt"
        else
          "org.scala-sbt"
        end
      }
      _cset(:sbt_launch_jar_url) {
        if exists?(:sbt_jar_url)
          logger.info(":sbt_jar_url has been deprecated. use :sbt_launch_jar_url instead.")
          fetch(:sbt_jar_url)
        else
          "http://typesafe.artifactoryonline.com/typesafe/ivy-releases/#{sbt_group_id}/sbt-launch/#{sbt_version}/sbt-launch.jar"
        end
      }
      _cset(:sbt_launch_jar) {
        if exists?(:sbt_jar_file)
          logger.info(":sbt_jar_file has been deprecated. use :sbt_launch_jar instead.")
          fetch(:sbt_jar_file)
        else
          File.join(sbt_path, "sbt-launch.jar")
        end
      }
      _cset(:sbt_launch_jar_local) {
        if exists?(:sbt_jar_file_local)
          logger.info(":sbt_jar_file_local has been deprecated. use :sbt_launch_jar_local instead.")
          fetch(:sbt_jar_file_local)
        else
          File.join(sbt_path_local, "sbt-launch.jar")
        end
      }
      _cset(:sbt_launch_jar_script) {
        (<<-EOS).gsub(/^\s*/, "")
          #!/bin/sh -e
          java -Xms512M -Xmx1536M -Xss1M -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=384M -jar `dirname $0`/sbt-launch.jar "$@"
        EOS
      }

      ## SBT environment
      _cset(:sbt_common_environment, {})
      _cset(:sbt_default_environment) {
        environment = {}
        if sbt_setup_remotely
          environment["JAVA_HOME"] = fetch(:sbt_java_home) if exists?(:sbt_java_home)
          environment["PATH"] = [ sbt_bin_path, "$PATH" ].join(":")
        end
        _merge_environment(sbt_common_environment, environment)
      }
      _cset(:sbt_default_environment_local) {
        environment = {}
        if sbt_setup_locally
          environment["JAVA_HOME"] = fetch(:sbt_java_home_local) if exists?(:sbt_java_home_local)
          environment["PATH"] = [ sbt_bin_path, "$PATH" ].join(":")
        end
        _merge_environment(sbt_common_environment, environment)
      }
      _cset(:sbt_environment) { _merge_environment(sbt_default_environment, fetch(:sbt_extra_environment, {})) }
      _cset(:sbt_environment_local) { _merge_environment(sbt_default_environment_local, fetch(:sbt_extra_environment_local, {})) }
      def _command(cmdline, options={})
        environment = options.fetch(:env, {})
        if environment.empty?
          cmdline
        else
          env = (["env"] + environment.map { |k, v| "#{k}=#{v.dump}" }).join(" ")
          "#{env} #{cmdline}"
        end
      end
      def command(cmdline, options={})
        _command(cmdline, :env => sbt_environment.merge(options.fetch(:env, {})))
      end
      def command_local(cmdline, options={})
        _command(cmdline, :env => sbt_environment_local.merge(options.fetch(:env, {})))
      end
      _cset(:sbt_cmd) { command("#{sbt_bin.dump} #{sbt_options.map { |x| x.dump }.join(" ")}") }
      _cset(:sbt_cmd_local) { command_local("#{sbt_bin_local.dump} #{sbt_options_local.map { |x| x.dump }.join(" ")}") }
      _cset(:sbt_goals, %w(reload clean package))
      _cset(:sbt_common_options) {
        options = []
        if fetch(:sbt_log_noformat, true)
          if sbt_use_extras
            options << "-no-colors"
          else
            options << "-Dsbt.log.noformat=true"
          end
        end
        options
      }
      _cset(:sbt_default_options) {
        options = sbt_common_options.dup
        if sbt_update_settings
          if sbt_use_extras
            options += ["-sbt-dir", sbt_settings_path]
          else
            options << "-Dsbt.global.base=#{sbt_settings_path}"
          end
        end
        options
      }
      _cset(:sbt_default_options_local) {
        options = sbt_common_options.dup
        if sbt_update_settings_locally
          if sbt_use_extras
            options += ["-sbt-dir", sbt_settings_path_local]
          else
            options << "-Dsbt.global.base=#{sbt_settings_path_local}"
          end
        end
        options
      }
      _cset(:sbt_options) { sbt_default_options + fetch(:sbt_extra_options, []) }
      _cset(:sbt_options_local) { sbt_default_options_local + fetch(:sbt_extra_options_local, []) }

      _cset(:sbt_setup_remotely) { sbt_update_remotely }
      _cset(:sbt_setup_locally) { sbt_update_locally }
      _cset(:sbt_update_remotely) { not(sbt_update_locally) }
      _cset(:sbt_update_locally) { # perform update on localhost
        if exists?(:sbt_compile_locally)
          logger.info(":sbt_compile_locally has been deprecated. use :sbt_update_locally instead.")
          fetch(:sbt_compile_locally, false)
        else
          false
        end
      }

      if top.namespaces.key?(:multistage)
        after "multistage:ensure", "sbt:setup_default_environment"
      else
        on :load do
          if top.namespaces.key?(:multistage)
            after "multistage:ensure", "sbt:setup_default_environment"
          else
            setup_default_environment
          end
        end
      end

      _cset(:sbt_environment_join_keys, %w(DYLD_LIBRARY_PATH LD_LIBRARY_PATH MANPATH PATH))
      def _merge_environment(x, y)
        x.merge(y) { |key, x_val, y_val|
          if sbt_environment_join_keys.include?(key)
            ( y_val.split(":") + x_val.split(":") ).uniq.join(":")
          else
            y_val
          end
        }
      end

      task(:setup_default_environment, :roles => sbt_roles, :except => { :no_release => true }) {
        if fetch(:sbt_setup_default_environment, true)
          set(:default_environment, _merge_environment(default_environment, sbt_environment))
        end
      }

      def _invoke_command(cmdline, options={})
        if options[:via] == :run_locally
          run_locally(cmdline)
        else
          invoke_command(cmdline, options)
        end
      end

      def _download_extras(uri, filename, options={})
        execute = []
        execute << "mkdir -p #{File.dirname(filename).dump}"
        if fetch(:sbt_update_extras, true)
          execute << %{t=$(mktemp /tmp/sbt.XXXXXXXXXX)}
          execute << %{touch -t #{sbt_extras_update_timestamp.dump} "$t"}
          execute << %{( test #{filename.dump} -nt "$t" || wget --no-verbose -O #{filename.dump} #{uri.dump}; rm -f "$t" )}
        else
          execute << %{( test -f #{filename.dump} || wget --no-verbose -O #{filename.dump} #{uri.dump} )}
        end
        execute << %{( test -x #{filename.dump} || chmod 755 #{filename.dump} )}
        _invoke_command(execute.join(" && "), options)
      end

      def _download_launch_jar(uri, filename, options={})
        execute = []
        execute << "mkdir -p #{File.dirname(filename).dump}"
        execute << "( test -f #{filename.dump} || wget --no-verbose -O #{filename.dump} #{uri.dump} )"
        _invoke_command(execute.join(" && "), options)
      end

      def _upload(filename, remote_filename, options={})
        mode = options.delete(:mode)
        _invoke_command("mkdir -p #{File.dirname(remote_filename).dump}", options)
        transfer_if_modified(:up, filename, remote_filename, fetch(:sbt_upload_options, {}).merge(options))
        if mode
          mode = mode.is_a?(Numeric) ? mode.to_s(8) : mode.to_s
          _invoke_command("chmod #{mode.dump} #{remote_filename.dump}", options)
        end
      end

      def _install_extras(filename, options={})
        # nop
      end

      def _install_launch_jar(jar, sbt, options={})
        via = options.delete(:via)
        if via == :run_locally
          run_locally("mkdir -p #{File.dirname(sbt).dump}")
          File.write(sbt, sbt_launch_jar_script)
          run_locally("( test -x #{sbt.dump} || chmod 755 #{sbt.dump} )")
        else
          safe_put(sbt_launch_jar_script, sbt, {:mode => "755", :run_method => via}.merge(options))
        end
      end

      def _installed?(destination, options={})
        sbt = File.join(destination, "sbt")
        cmdline = "test -d #{destination.dump} && test -x #{sbt.dump}"
        _invoke_command(cmdline, options)
        true
      rescue
        false
      end

      ## setup
      desc("Setup sbt.")
      task(:setup, :roles => sbt_roles, :except => { :no_release => true }) {
        transaction {
          setup_remotely if sbt_setup_remotely
          setup_locally if sbt_setup_locally
        }
      }
      after "deploy:setup", "sbt:setup"

      task(:setup_remotely, :roles => sbt_roles, :except => { :no_release => true }) {
        if sbt_use_extras
          _download_extras(sbt_extras_url, sbt_bin_local, :via => :run_locally)
          _upload(sbt_bin_local, sbt_bin, :mode => "755")
          unless _installed?(sbt_path)
            _install_extras(sbt_bin)
          end
        else
          _download_launch_jar(sbt_launch_jar_url, sbt_launch_jar_local, :via => :run_locally)
          _upload(sbt_launch_jar_local, sbt_launch_jar, :mode => "644")
          unless _installed?(sbt_path)
            _install_launch_jar(sbt_launch_jar, sbt_bin)
          end
        end
        _installed?(sbt_path)
        update_settings if sbt_update_settings
      }

      desc("Setup sbt locally.")
      task(:setup_locally, :roles => sbt_roles, :except => { :no_release => true }) {
        if sbt_use_extras
          _download_extras(sbt_extras_url, sbt_bin_local, :via => :run_locally)
          unless _installed?(sbt_path_local, :via => :run_locally)
            _install_extras(sbt_bin_local, :via => :run_locally)
          end
        else
          _download_launch_jar(sbt_launch_jar_url, sbt_launch_jar_local, :via => :run_locally)
          unless _installed?(sbt_path_local, :via => :run_locally)
            _install_launch_jar(sbt_launch_jar_local, sbt_bin_local, :via => :run_locally)
          end
        end
        _installed?(sbt_path_local, :via => :run_locally)
        update_settings_locally if sbt_update_settings_locally
      }

      _cset(:sbt_update_settings) { sbt_setup_remotely and not(sbt_settings.empty?) }
      _cset(:sbt_update_settings_locally) { sbt_setup_locally and not(sbt_settings_local.empty?) }
      _cset(:sbt_settings_path) { File.join(sbt_project_path, "sbt") } # sbt.global.base
      _cset(:sbt_settings_path_local) { File.join(sbt_project_path_local, "sbt") } # sbt.global.base
      _cset(:sbt_settings, [])
      _cset(:sbt_settings_local) { sbt_settings }
      task(:update_settings, :roles => sbt_roles, :except => { :no_release => true }) {
        sbt_settings.each do |file|
          safe_put(template(file, :path => sbt_template_path), File.join(sbt_settings_path, file))
        end
      }

      task(:update_settings_locally, :rols => sbt_roles, :except => { :no_release => true }) {
        sbt_settings_local.each do |file|
          destination = File.join(sbt_settings_path_local, file)
          run_locally("mkdir -p #{File.dirname(destination).dump}")
          File.write(destination, template(file, :path => sbt_template_path))
        end
      }

      ## update
      desc("Update sbt build.")
      task(:update, :roles => sbt_roles, :except => { :no_release => true }) {
        transaction {
          update_remotely if sbt_update_remotely
          update_locally if sbt_update_locally
        }
      }
      _cset(:sbt_update_hook_type, :after)
      _cset(:sbt_update_hook, "deploy:finalize_update")
      on(:load) do
        [ sbt_update_hook ].flatten.each do |hook|
          send(sbt_update_hook_type, hook, "sbt:update") if hook
        end
      end

      task(:update_remotely, :roles => sbt_roles, :except => { :no_release => true }) {
        execute_remotely
      }

      desc("Update sbt build locally.")
      task(:update_locally, :roles => sbt_roles, :except => { :no_release => true }) {
        execute_locally
        upload_locally
      }

      def _parse_project_version(s)
        # FIXME: is there any better way to get project version?
        lastline = s.split(/(?:\r?\n)+/)[-1]
        lastline.split[-1]
      end

      _cset(:sbt_project_version) {
        _parse_project_version(sbt.exec(["show version"], :via => :capture))
      }
      _cset(:sbt_project_version_local) {
        _parse_project_version(sbt.exec_locally(["show version"], :via => :capture_locally))
      }
      _cset(:sbt_snapshot_pattern, /-SNAPSHOT$/i)
      def _validate_project_version(key)
        if fetch(:sbt_release_build, false)
          version = fetch(key)
          abort("Skip to build project since \`#{version}' is a SNAPSHOT version.") if sbt_snapshot_pattern === version
        end
      end

      desc("Perform sbt build.")
      task(:execute, :roles => sbt_roles, :except => { :no_release => true }) {
        execute_remotely
      }

      task(:execute_remotely, :roles => sbt_roles, :except => { :no_release => true }) {
        on_rollback do
          sbt.exec("clean")
        end
        _validate_project_version(:sbt_project_version)
        sbt.exec(sbt_goals)
      }

      desc("Perform sbt build locally.")
      task(:execute_locally, :roles => sbt_roles, :except => { :no_release => true }) {
        on_rollback {
          sbt.exec_locally("clean")
        }
        _validate_project_version(:sbt_project_version_local)
        sbt.exec_locally(sbt_goals)
      }

      task(:upload_locally, :rolse => sbt_roles, :except => { :no_release => true }) {
        on_rollback do
          run("rm -rf #{sbt_target_path.dump}")
        end
        filename = "#{sbt_target_path_local}.tar.gz"
        remote_filename = "#{sbt_target_path}.tar.gz"
        begin
          run_locally("cd #{File.dirname(sbt_target_path_local).dump} && tar chzf #{filename.dump} #{File.basename(sbt_target_path_local).dump}")
          run("mkdir -p #{File.dirname(sbt_target_path).dump}")
          top.upload(filename, remote_filename)
          run("cd #{File.dirname(sbt_target_path).dump} && tar xzf #{remote_filename.dump}")
        ensure
          run("rm -f #{remote_filename.dump}") rescue nil
          run_locally("rm -f #{filename.dump}") rescue nil
        end
      }

      def _exec_command(args=[], options={})
        args = [ args ].flatten
        sbt = options.fetch(:sbt, "sbt")
        execute = []
        execute << "cd #{options[:path].dump}" if options.key?(:path)
        execute << "#{sbt} #{args.map { |x| x.dump }.join(" ")}"
        execute.join(" && ")
      end

      ## public methods
      def exec(args=[], options={})
        cmdline = _exec_command(args, { :path => sbt_project_path, :sbt => sbt_cmd, :via => :run }.merge(options))
        _invoke_command(cmdline, options)
      end

      def exec_locally(args=[], options={})
        via = options.delete(:via)
        cmdline = _exec_command(args, { :path => sbt_project_path_local, :sbt => sbt_cmd_local, :via => :run_locally }.merge(options))
        if via == :capture_locally
          _invoke_command(cmdline, options.merge(:via => :run_locally))
        else
          logger.trace("executing locally: #{cmdline.dump}")
          elapsed = Benchmark.realtime do
            system(cmdline)
          end
          if $?.to_i > 0 # $? is command exit code (posix style)
            raise Capistrano::LocalArgumentError, "Command #{cmdline} returned status code #{$?}"
          end
          logger.trace "command finished in #{(elapsed * 1000).round}ms"
        end
      end
    }
  }
end