flash_flow 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aff3163ea68205769ff9157ffcc3186797b571c
-  data.tar.gz: d917594c16e2f836b6572922a227df7f696bbd39
+  metadata.gz: 4b4faf52faa0345d39f5a6b125d897a33ef97dc6
+  data.tar.gz: 96e3e0f1160587d5bbd972a4357f82c92807704d
 SHA512:
-  metadata.gz: 39d51941b834bc218524412c37e7fd02309a3e947e39aad06ff5b45ff0815fa65c79bb6939accff3c98072c0c119e3e82753f195c1f9901101ae27b5694c4238
-  data.tar.gz: 75ba31076eaa53acb0f84a81088f7dcd4e21e892e03bd9903be25ba38df81f4c87c3fd747f49bead11ce399bf6857b6643d16a14fe0f60c412b56df2917d585f
+  metadata.gz: d513f6f38ac8bd6e8e44e2e380975f7fafd9c1f28c60999b1d91d33312daff171fd97e855a3d9fdcfa5f1190dad7ae4f3caab9b5336d7531d1dd96b13a0b372d
+  data.tar.gz: 5767d8b4b74060742e2a50b50aaa7b782c7858fec8badbfc4d6c2e05402052b3f285c0ca13029a4f6920b28a82b1ac194571e93f7d4c924f0bd67bdaab52bbb4

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    flash_flow (1.4.5)
+    flash_flow (1.4.6)
       hipchat (~> 1.5)
+      mail
       octokit (~> 4.1)
       percy-client
       pivotal-tracker (~> 0.5)
@@ -33,9 +34,9 @@ GEM
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
     httpclient (2.8.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99.2)
     mimemagic (0.3.1)
     mini_portile2 (2.1.0)
     minitest (5.3.5)

data/bin/flash_flow

@@ -20,6 +20,8 @@ case
     FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).stories_delivered
   when options[:release_notes]
     FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).release_notes(options[:release_notes])
+  when options[:release_email]
+    FlashFlow::Release::Base.new(FlashFlow::Config.configuration.release).send_release_email
   when options[:resolve]
     FlashFlow::Resolve.new(FlashFlow::Config.configuration.git, FlashFlow::Config.configuration.branch_info_file, logger: FlashFlow::Config.configuration.logger).start
   when options[:resolve_manual]

data/flash_flow.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pivotal-tracker', "~> 0.5"
   spec.add_dependency 'ruby-graphviz', "> 0"
   spec.add_dependency 'percy-client'
+  spec.add_dependency 'mail'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "> 0"

data/flash_flow.yml.erb.example

@@ -85,7 +85,24 @@ branch_info_file: 'your/random/file'
 
 #release:
 #  class:
-#    name: 'FlashFlow::Release::Percy'
+#    name: 'FlashFlow::Release::PercyClient'
 #    token: <%= ENV['PERCY_TOKEN'] %>
 #    repo: # Your github repo. For example, the flash_flow repo is 'flashfunders/flash_flow'
 #    api_url: 'https://percy.io/api/v1/'
+#    email: 'foo@bar.com'
+#    cc_email: 'bar@foo.com'
+#smtp:
+#  settings:
+#    domain: 'yourdomain.com'
+#    address: <%= ENV['SMTP_ADDRESS'] %>
+#    user_name: <%= ENV['SMTP_USERNAME'] %>
+#    password: <%= ENV['SMTP_PASSWORD'] %>
+#    port: 587
+#    authentication: 'plain'
+#    enable_starttls_auto: true
+#  emails:
+#    from: 'sender@domain.com'
+#    to: 'receiver@domain.com'
+#    cc: 'cc@domain.com'
+#    subject: 'The engineering team has a new release candidate'
+#    body_file: 'path/to/email_template.erb'

data/lib/flash_flow.rb

@@ -7,3 +7,4 @@ require 'flash_flow/issue_tracker'
 require 'flash_flow/resolve'
 require 'flash_flow/merge'
 require 'flash_flow/release'
+require 'flash_flow/mailer'

data/lib/flash_flow/config.rb

@@ -16,7 +16,7 @@ module FlashFlow
     end
 
     ATTRIBUTES = [
-        :git, :branch_info_file, :log_file, :notifier, :issue_tracker, :lock, :branches, :release
+      :git, :branch_info_file, :log_file, :notifier, :issue_tracker, :lock, :branches, :release, :smtp
     ]
 
     attr_reader *ATTRIBUTES
@@ -55,7 +55,8 @@ module FlashFlow
           issue_tracker: nil,
           lock: nil,
           branches: nil,
-          release: nil
+          release: nil,
+          smtp: nil
       }
     end
 

data/lib/flash_flow/git.rb

@@ -4,6 +4,7 @@ require 'shellwords'
 module FlashFlow
   class Git
     ATTRIBUTES = [:remote, :merge_branch, :master_branch, :release_branch, :use_rerere]
+
     attr_reader *ATTRIBUTES
     attr_reader :working_branch
 

data/lib/flash_flow/mailer.rb

@@ -0,0 +1,45 @@
+require 'mail'
+
+module FlashFlow
+  module Mailer
+    class Base
+
+      def initialize(config)
+        unless config&.fetch('settings', false)
+          raise RuntimeError.new("smtp settings must be set in your flash flow config.")
+        end
+
+        configure!(config['settings'])
+      end
+
+      def deliver!(data={})
+        delivery_info = Config.configuration.smtp["emails"]
+
+        if delivery_info
+          delivery_info["body_html"] = body_html(data, delivery_info["body_file"])
+
+          Mail.deliver do
+            from     delivery_info["from"]
+            to       delivery_info["to"]
+            cc       delivery_info["cc"]
+            subject  delivery_info["subject"]
+            body     delivery_info["body_html"]
+          end
+        end
+      end
+
+      private
+
+      def configure!(config)
+        Mail.defaults { delivery_method :smtp, config.symbolize_keys }
+      end
+
+      def body_html(data, template)
+        @data = data
+        erb_template = ERB.new File.read(template)
+        erb_template.result(binding)
+      end
+
+    end
+  end
+end

data/lib/flash_flow/options.rb

@@ -13,6 +13,7 @@ module FlashFlow
         opts.on('--prod-deploy', 'Run IssueTracker#deploy_production and exit') { |v| options[:prod_deploy] = true }
         opts.on('--review-deploy', 'Run IssueTracker#deploy_review and exit') { |v| options[:review_deploy] = true }
         opts.on('--release-notes hours', 'Run IssueTracker#release_notes and exit') { |v| options[:release_notes] = v }
+        opts.on('--release-email', 'Send an email with a latest build info and exit') { |v| options[:release_email] = v }
         opts.on('-n', '--no-merge', 'Run flash flow, but do not merge this branch') { |v| options[:do_not_merge] = true }
         opts.on('--rerere-forget', 'Delete the saved patch for this branch and let the merge fail if there is a conflict') { |v| options[:rerere_forget] = true }
         opts.on('--story id1', 'story id for this branch') { |v| options[:stories] = [v] }
@@ -24,7 +25,6 @@ module FlashFlow
         opts.on('--merge-status', 'Show status of all branches and their stories and exit') { |v| options[:merge_status] = true }
         opts.on('--merge-status-html', 'Show status of all branches and their stories in html format and exit') { |v| options[:merge_status_html] = true }
         opts.on('--make-release branch1,branch2', 'Comma-delimited list of branches to merge to the release branch. Run "--merge-release ready" to merge all ready to ship branches') { |v| options[:release_branches] = v.split(',') }
-        opts.on('--merge-release', 'Merge the release branch into the master branch and push') { |v| options[:merge_release] = v.split(',') }
 
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts

data/lib/flash_flow/release.rb

@@ -15,6 +15,10 @@ module FlashFlow
         @release.find_latest_by_sha(sha) if @release.respond_to?(:find_latest_by_sha)
       end
 
+      def send_release_email
+        @release.send_release_email if @release.respond_to?(:send_release_email)
+      end
+
     end
   end
 end

data/lib/flash_flow/release/percy_client.rb

@@ -1,4 +1,6 @@
 require 'percy'
+require 'flash_flow/git'
+require 'flash_flow/mailer'
 
 module FlashFlow
   module Release
@@ -6,14 +8,21 @@ module FlashFlow
 
       def initialize(config={})
         @client = initialize_connection!(config['token'])
+        @git = ShadowGit.new(Config.configuration.git, Config.configuration.logger)
       end
 
       def find_latest_by_sha(sha)
         response = get_builds
         commit = find_commit_by_sha(response, sha)
-        build = find_build_by_commit_id(response, commit['id'])
+        find_build_by_commit_id(response, commit['id'])
+      end
+
+      def send_release_email
+        build = find_latest_by_sha(get_latest_sha)
 
-        { url: build['web-url'], approved: !build['approved-at'].nil? }
+        if has_unapproved_diffs?(build)
+          mailer.deliver!(percy_build_url: build['web-url'])
+        end
       end
 
       private
@@ -24,10 +33,6 @@ module FlashFlow
         end
 
         Percy.client.config.access_token = token
-        percy_client
-      end
-
-      def percy_client
         Percy.client
       end
 
@@ -40,26 +45,35 @@ module FlashFlow
       end
 
       def find_build_by_commit_id(response, commit_id)
-        builds = builds_collection(response)
-        return if builds.nil?
-
-        latest_build = builds
+        builds_collection(response)
           .select { |b| b.dig('relationships', 'commit', 'data', 'id') == commit_id }
           .sort_by { |b| DateTime.parse(b.dig('attributes', 'created-at')) }.last
-
-        latest_build['attributes']
+          &.fetch('attributes', {}) || {}
       end
 
       def builds_collection(response)
-        response['data'].select do |h|
-          h['type'] == 'builds' &&
+        response.fetch('data', [])
+          .select do |h| h['type'] == 'builds' &&
             h.dig('attributes', 'web-url') &&
             h.dig('relationships', 'commit', 'data', 'type') == 'commits'
-        end
+          end
       end
 
       def commits_data(response)
-        response['included'].select { |data| data['type'] == 'commits' }
+        response.fetch('included', {'id' => nil})
+          .select { |data| data['type'] == 'commits' }
+      end
+
+      def has_unapproved_diffs?(build)
+        build['total-comparisons-diff'] > 0 && build['approved-at'].nil?
+      end
+
+      def get_latest_sha
+        @git.get_sha(@git.release_branch)
+      end
+
+      def mailer
+        @mailer ||= FlashFlow::Mailer::Base.new(Config.configuration.smtp)
       end
 
     end

data/lib/flash_flow/version.rb

@@ -1,3 +1,3 @@
 module FlashFlow
-  VERSION = "1.4.5"
+  VERSION = "1.4.6"
 end

data/test/lib/release/test_percy_client.rb

@@ -6,15 +6,41 @@ module FlashFlow
     class TestPercyClient < Minitest::Test
 
       def setup
+        configuration = {}
+          .merge(git_config)
+          .merge(smtp_config)
+        reset_config!
+        config!(configuration)
+
         @percy_client = Release::PercyClient.new({'token' => ''})
       end
 
       def test_find_latest_by_sha
         @percy_client.stub(:get_builds, sample_response) do
-          results = @percy_client.send(:find_latest_by_sha, 'aaaaa')
-          assert_equal(results[:url], 'https://percy.io/repo/builds/2222')
-          assert_equal(results[:approved], true)
+          results = @percy_client.find_latest_by_sha('aaaaa')
+          assert(results.has_key?('web-url'))
+          assert(results.has_key?('approved-at'))
+          assert(results.has_key?('total-comparisons-diff'))
+        end
+      end
+
+      def test_send_release_email
+        @git = Minitest::Mock.new
+          .expect(:release_branch, 'release')
+          .expect(:get_sha, 'bbbbb', ['release'])
+
+        @mailer = Minitest::Mock.new
+        @mailer.expect(:deliver!, true, [{percy_build_url: 'https://percy.io/repo/builds/1111'}])
+
+        @percy_client.instance_variable_set('@git'.to_sym, @git)
+        @percy_client.instance_variable_set('@mailer'.to_sym, @mailer)
+
+        @percy_client.stub(:get_builds, sample_response) do
+          @percy_client.send_release_email
         end
+
+        @git.verify
+        @mailer.verify
       end
 
       def test_find_commit_by_sha
@@ -30,6 +56,16 @@ module FlashFlow
         assert(!build['approved-at'].nil?)
       end
 
+      def test_has_unapproved_diffs?
+        @percy_client.stub(:get_builds, sample_response) do
+          build1 = @percy_client.find_latest_by_sha('bbbbb')
+          assert(@percy_client.send(:has_unapproved_diffs?, build1))
+
+          build2 = @percy_client.find_latest_by_sha('aaaaa')
+          refute(@percy_client.send(:has_unapproved_diffs?, build2))
+        end
+      end
+
       private
 
       def sample_response
@@ -39,6 +75,7 @@ module FlashFlow
                 "type": "builds",
                 "attributes": {
                   "web-url": "https://percy.io/repo/builds/1111",
+                  "total-comparisons-diff": 1,
                   "approved-at": null,
                   "created-at": "2016-08-01T00:00:00.000Z"
                 },
@@ -46,7 +83,7 @@ module FlashFlow
                   "commit": {
                     "data": {
                       "type": "commits",
-                      "id": "9999"
+                      "id": "8888"
                     }
                   }
                 }
@@ -55,6 +92,7 @@ module FlashFlow
                 "type": "builds",
                 "attributes": {
                   "web-url": "https://percy.io/repo/builds/2222",
+                  "total-comparisons-diff": 0,
                   "approved-at": "2016-08-01T22:41:58.000Z",
                   "created-at": "2016-08-01T11:11:11.111Z"
                 },
@@ -87,6 +125,24 @@ module FlashFlow
           }')
       end
 
+      def git_config
+        {
+          git: {
+            'merge_branch' => 'test_acceptance',
+            'merge_remote' => 'test_remote',
+            'master_branch' => 'test_master',
+            'remotes' => ['fake_origin'],
+            'use_rerere' => true
+          }
+        }
+      end
+
+      def smtp_config
+        {
+          smtp: {}
+        }
+      end
+
     end
   end
 end

data/test/lib/test_config.rb

@@ -30,7 +30,8 @@ module FlashFlow
               'class' => {
                   'name' => 'BranchClass'
               }
-          }
+          },
+          'smtp' => {}
       }
 
       reset_config!
@@ -72,9 +73,9 @@ module FlashFlow
         assert_nil(config.lock)
       end
     end
-    
+
     private
-    
+
     def config
       Config.configuration
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flash_flow
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Flashfunders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-13 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +199,7 @@ files:
 - lib/flash_flow/issue_tracker/pivotal.rb
 - lib/flash_flow/lock.rb
 - lib/flash_flow/lock/github.rb
+- lib/flash_flow/mailer.rb
 - lib/flash_flow/merge.rb
 - lib/flash_flow/merge/acceptance.rb
 - lib/flash_flow/merge/base.rb