bugsnag-capistrano 1.1.0 → 2.1.0

data/lib/bugsnag-capistrano/tasks/bugsnag.cap

@@ -1,46 +1,42 @@
 namespace :load do
-
   task :defaults do
-
     set :bugsnag_default_hooks, ->{ true }
-
   end
-
 end
 
 namespace :deploy do
-
   before :starting, :bugsnag_hooks do
     invoke 'bugsnag:add_default_hooks' if fetch(:bugsnag_default_hooks)
   end
-
 end
 
 namespace :bugsnag do
-
   task :add_default_hooks do
-    after 'deploy:published', 'bugsnag:deploy'
+    after 'deploy:published', 'bugsnag:release'
   end
 
-  desc 'Notify Bugsnag that new production code has been deployed'
-  task :deploy do
+  desc 'Notify Bugsnag that new production code has been released'
+  task :release do
     run_locally do
       begin
-        Bugsnag::Capistrano::Deploy.notify({
+        auto_assign_release_bool = ENV["BUGSNAG_AUTO_ASSIGN_RELEASE"] == 'true'
+        Bugsnag::Capistrano::Release.notify({
           :api_key => fetch(:bugsnag_api_key, ENV["BUGSNAG_API_KEY"]),
+          :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
+          :auto_assign_release => fetch(:bugsnag_auto_assign_release, auto_assign_release_bool),
+          :builder_name => fetch(:bugsnag_builder, ENV["BUGSNAG_BUILDER_NAME"] || ENV["USER"]),
+          :metadata => fetch(:bugsnag_metadata),
           :release_stage => fetch(:bugsnag_env) || ENV["BUGSNAG_RELEASE_STAGE"] || fetch(:rails_env) || fetch(:stage) || "production",
           :revision => fetch(:current_revision, ENV["BUGSNAG_REVISION"]),
-          :repository => fetch(:repo_url, ENV["BUGSNAG_REPOSITORY"]),
-          :branch => fetch(:branch, ENV["BUGSNAG_BRANCH"]),
-          :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
+          :repository => fetch(:bugsnag_repo_url, fetch(:repo_url, ENV["BUGSNAG_REPOSITORY"])),
+          :source_control_provider => fetch(:bugsnag_source_control_provider, ENV["BUGSNAG_SOURCE_CONTROL_PROVIDER"]),
           :endpoint => fetch(:bugsnag_endpoint)
         })
-        info 'Bugsnag deploy notification complete.'
+        info 'Bugsnag release notification complete.'
       rescue
-        error "Bugsnag deploy notification failed, #{$!.inspect}"
+        error "Bugsnag release notification failed, #{$!.inspect}"
       end
     end
   end
-
 end
 # vi:ft=ruby

data/spec/capistrano_spec.rb

@@ -1,65 +1,116 @@
-require 'webmock/rspec'
-require 'rspec/expectations'
-require 'rspec/mocks'
-
-require 'webrick'
-
-describe "bugsnag capistrano", :always do
-
-  server = nil
-  queue = Queue.new
-  cap_2 = ENV['CAP_2_TEST'] == 'true'
-  fixture_path = cap_2 ? '../examples/capistrano2' : '../examples/capistrano3'
-  exec_string = cap_2 ? 'bundle exec cap deploy' : 'bundle exec cap test deploy'
-  example_path = File.join(File.dirname(__FILE__), fixture_path)
-
-  before do
-    server = WEBrick::HTTPServer.new :Port => 0, :Logger => WEBrick::Log.new(STDOUT), :AccessLog => []
-    server.mount_proc '/deploy' do |req, res|
-      queue.push req.body
-      res.status = 200
-      res.body = "OK\n"
-    end
-    Thread.new{ server.start }
-  end
+require_relative './spec_helper'
 
-  after do
-    server.stop
-    queue.clear
-  end
+describe "bugsnag capistrano" do
+  server = Helpers::Server.new
+
+  before { server.start }
+  after { server.stop }
 
-  let(:request) { JSON.parse(queue.pop) }
-  
   it "sends a deploy notification to the set endpoint" do
-    ENV['BUGSNAG_ENDPOINT'] = "http://localhost:" + server.config[:Port].to_s + "/deploy"
-    
-    Dir.chdir(example_path) do
-      system(exec_string)
+    ENV['BUGSNAG_ENDPOINT'] = server.url
+    ENV['BUGSNAG_APP_VERSION'] = "1"
+
+    Dir.chdir(Helpers::Capistrano.example_path) do
+      system(Helpers::Capistrano.deploy_command)
     end
 
-    payload = request()
+    payload = server.last_request
     expect(payload["apiKey"]).to eq('YOUR_API_KEY')
+    expect(payload["appVersion"]).to eq("1")
     expect(payload["releaseStage"]).to eq('production')
   end
 
   it "allows modifications of deployment characteristics" do
-    ENV['BUGSNAG_ENDPOINT'] = "http://localhost:" + server.config[:Port].to_s + "/deploy"
+    ENV['BUGSNAG_ENDPOINT'] = server.url
     ENV['BUGSNAG_API_KEY'] = "this is a test key"
     ENV['BUGSNAG_RELEASE_STAGE'] = "test"
     ENV['BUGSNAG_REVISION'] = "test"
     ENV['BUGSNAG_APP_VERSION'] = "1"
     ENV['BUGSNAG_REPOSITORY'] = "test@repo.com:test/test_repo.git"
+    ENV['BUGSNAG_SOURCE_CONTROL_PROVIDER'] = "github"
+    ENV['BUGSNAG_AUTO_ASSIGN_RELEASE'] = 'true'
 
-    Dir.chdir(example_path) do
-      system(exec_string)
+    Dir.chdir(Helpers::Capistrano.example_path) do
+      system(Helpers::Capistrano.deploy_command)
     end
 
-    payload = request()
+    payload = server.last_request
     expect(payload["apiKey"]).to eq('this is a test key')
     expect(payload["releaseStage"]).to eq('test')
-    expect(payload["repository"]).to eq("test@repo.com:test/test_repo.git")
     expect(payload["appVersion"]).to eq("1")
-    expect(payload["revision"]).to eq("test")
+    expect(payload["sourceControl"]).to_not be_nil
+    expect(payload["sourceControl"]["revision"]).to eq("test")
+    expect(payload["sourceControl"]["repository"]).to eq("test@repo.com:test/test_repo.git")
+    expect(payload["sourceControl"]["provider"]).to eq("github")
+    expect(payload["autoAssignRelease"]).to eq(true)
   end
-end
 
+  it "uses 'repo_url' in preference to 'BUGSNAG_REPOSITORY'" do
+    ENV['BUGSNAG_REPOSITORY'] = "unused@repo.com:unused/unused_repo.git"
+
+    capfile = Helpers::Capistrano.generate_capfile({
+      bugsnag_api_key: "this is a test key",
+      app_version: "1",
+      bugsnag_auto_assign_release: true,
+      bugsnag_builder: "bob",
+      bugsnag_metadata: { a: 1, b: 2 },
+      bugsnag_env: "test",
+      current_revision: "test1234",
+      repo_url: "test@repo.com:test/test_repo.git",
+      bugsnag_source_control_provider: "github",
+      bugsnag_endpoint: server.url,
+    })
+
+    Helpers::Capistrano.run(capfile)
+
+    payload = server.last_request
+
+    expect(payload["apiKey"]).to eq('this is a test key')
+    expect(payload["appVersion"]).to eq("1")
+    expect(payload["autoAssignRelease"]).to eq(true)
+    expect(payload["builderName"]).to eq("bob")
+    expect(payload["buildTool"]).to eq("bugsnag-capistrano")
+    expect(payload["metadata"]).to eq({ "a" => 1, "b" => 2 })
+    expect(payload["releaseStage"]).to eq("test")
+    expect(payload["sourceControl"]).to eq({
+      "revision" => "test1234",
+      "repository" => "test@repo.com:test/test_repo.git",
+      "provider" => "github",
+    })
+  end
+
+  it "uses 'bugsnag_repo_url' in preference to 'repo_url'" do
+    ENV['BUGSNAG_REPOSITORY'] = "unused@repo.com:unused/unused_repo.git"
+
+    capfile = Helpers::Capistrano.generate_capfile({
+      bugsnag_api_key: "this is a test key",
+      app_version: "1",
+      bugsnag_auto_assign_release: true,
+      bugsnag_builder: "bob",
+      bugsnag_metadata: { a: 1, b: 2 },
+      bugsnag_env: "test",
+      current_revision: "test1234",
+      repo_url: "test@repo.com:test/test_repo.git",
+      bugsnag_repo_url: "https://repo.com/test/test_repo.git",
+      bugsnag_source_control_provider: "github",
+      bugsnag_endpoint: server.url,
+    })
+
+    Helpers::Capistrano.run(capfile)
+
+    payload = server.last_request
+
+    expect(payload["apiKey"]).to eq('this is a test key')
+    expect(payload["appVersion"]).to eq("1")
+    expect(payload["autoAssignRelease"]).to eq(true)
+    expect(payload["builderName"]).to eq("bob")
+    expect(payload["buildTool"]).to eq("bugsnag-capistrano")
+    expect(payload["metadata"]).to eq({ "a" => 1, "b" => 2 })
+    expect(payload["releaseStage"]).to eq("test")
+    expect(payload["sourceControl"]).to eq({
+      "revision" => "test1234",
+      "repository" => "https://repo.com/test/test_repo.git",
+      "provider" => "github",
+    })
+  end
+end

data/spec/helpers/capistrano.rb

@@ -0,0 +1,71 @@
+require 'tmpdir'
+require 'fileutils'
+
+module Helpers
+  class Capistrano
+    def self.version_2?
+      ENV['CAP_2_TEST'] == 'true'
+    end
+
+    def self.deploy_command
+      return 'bundle exec cap deploy' if version_2?
+
+      'bundle exec cap test deploy'
+    end
+
+    def self.example_path
+      fixture_path = version_2? ? '../../examples/capistrano2' : '../../examples/capistrano3'
+
+      File.join(File.dirname(__FILE__), fixture_path)
+    end
+
+    def self.generate_capfile(variables)
+      return generate_v2_capfile(variables) if version_2?
+
+      capfile = <<-RUBY.gsub(/^\s+/, "")
+        require "capistrano/setup"
+
+        require "capistrano/deploy"
+        require "capistrano/scm/git"
+        install_plugin Capistrano::SCM::Git
+
+        require "bugsnag-capistrano"
+      RUBY
+
+      # add calls to set each variable - "set(:key, value)"
+      variables.each do |key, value|
+        capfile << "set(:#{key}, #{value.inspect})\n"
+      end
+
+      capfile
+    end
+
+    def self.generate_v2_capfile(variables)
+      capfile = "require 'bugsnag-capistrano'\n"
+
+      # add calls to set each variable - "set(:key, value)"
+      variables.each do |key, value|
+        capfile << "set(:#{key}, #{value.inspect})\n"
+      end
+
+      # add an empty deploy task
+      capfile << "task :deploy do\nend"
+
+      capfile
+    end
+
+    def self.run(capfile)
+      Dir.mktmpdir do |path|
+        FileUtils.cp_r("#{example_path}/.", path)
+
+        File.open("#{path}/Capfile", "w") do |file|
+          file.write(capfile)
+        end
+
+        Dir.chdir(path) do
+          system(deploy_command)
+        end
+      end
+    end
+  end
+end

data/spec/helpers/server.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'webrick'
+
+module Helpers
+  class Server
+    def initialize
+      @queue = Queue.new
+      @server = nil
+      @thread = nil
+    end
+
+    def start
+      @server = WEBrick::HTTPServer.new({
+        Port: 0,
+        Logger: WEBrick::Log.new(STDOUT),
+        AccessLog: []
+      })
+
+      @server.mount_proc('/deploy') do |req, res|
+        @queue.push(req.body)
+
+        res.status = 200
+        res.body = "OK\n"
+      end
+
+      @thread = Thread.new { @server.start }
+
+      loop do
+        break if @server.status == :Running
+
+        sleep(0.1)
+      end
+    end
+
+    def stop
+      @queue.clear
+      @server.stop
+      @thread.join(5)
+      @server = nil
+    end
+
+    def url
+      raise "Server is not running!" if @server.nil?
+
+      "http://localhost:" + @server.config[:Port].to_s + "/deploy"
+    end
+
+    def last_request
+      retries = 0
+
+      begin
+        JSON.parse(@queue.pop(true))
+      rescue ThreadError
+        raise if retries >= 10
+
+        retries += 1
+        sleep(0.1)
+
+        retry
+      end
+    end
+  end
+end

data/spec/release_spec.rb

@@ -0,0 +1,94 @@
+require_relative './spec_helper'
+
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'webmock/rspec'
+
+require 'bugsnag-capistrano/release'
+
+module Bugsnag::Capistrano
+  class Release
+    attr_accessor :logger
+  end
+end
+
+describe Bugsnag::Capistrano::Release do
+  it "should call notify_without bugsnag" do
+    expect(Bugsnag::Capistrano::Release).to receive(:deliver)
+    Bugsnag::Capistrano::Release.notify({:api_key => "test", :app_version => "1"})
+  end
+
+  it "delivers a request to the given url" do
+    url = "http://localhost:56456"
+    stub_request(:post, url)
+      .to_return(status:200, body: "")
+    Bugsnag::Capistrano::Release.deliver(url, nil)
+  end
+
+  it "delivers a body unmodified" do
+    body = ::JSON.dump({
+      "paramA" => 'a',
+      "paramB" => 'b',
+      "paramHash" => {
+        "one" => 1,
+        "two" => 2,
+        "three" => 3
+      }
+    })
+    url = "http://localhost:56456"
+    request = stub_request(:post, url)
+      .with(body: body, headers: { 'Content-Type' => 'application/json'})
+      .to_return(status:200, body: "")
+    Bugsnag::Capistrano::Release.deliver(url, body)
+    assert_requested request
+  end
+
+  it "cannot send without an apikey" do
+    expect(Bugsnag::Capistrano::Release).to_not receive(:deliver)
+    expect(Bugsnag::Capistrano::Release.logger).to receive(:warn).with("Cannot deliver notification. Missing required apiKey")
+
+    Bugsnag::Capistrano::Release.notify()
+  end
+
+  it "cannot send without an appVersion" do
+    expect(Bugsnag::Capistrano::Release).to_not receive(:deliver)
+    expect(Bugsnag::Capistrano::Release.logger).to receive(:warn).with("Cannot deliver notification. Missing required appVersion")
+
+    Bugsnag::Capistrano::Release.notify({:api_key => "test"})
+  end
+
+  context "with bugsnag installed" do
+    before do
+      module Kernel
+        alias_method :old_require, :require
+        def require(path)
+          old_require(path) unless /^bugsnag/.match(path)
+        end
+      end
+    end
+
+    it "gets information from bugsnag configuration if available" do
+      config = double
+      allow(config).to receive(:api_key).and_return("bugsnag_api_key")
+      allow(config).to receive(:app_version).and_return("bugsnag_app_version")
+      allow(config).to receive(:release_stage).and_return("bugsnag_release_stage")
+
+      allow(Bugsnag).to receive(:configuration).and_return(config)
+      expect(Bugsnag::Capistrano::Release).to receive(:deliver) do |uri, body_string|
+        expect(uri).to eq(Bugsnag::Capistrano::Release::DEFAULT_BUILD_ENDPOINT)
+        body = ::JSON.parse(body_string)
+        expect(body["apiKey"]).to eq("bugsnag_api_key")
+        expect(body["appVersion"]).to eq("bugsnag_app_version")
+        expect(body["releaseStage"]).to eq("bugsnag_release_stage")
+      end
+
+      Bugsnag::Capistrano::Release.notify()
+    end
+
+    after do
+      module Kernel
+        alias_method :require, :old_require
+      end
+    end
+  end
+end