support git submodules and depth from in

Author: jtarchie

README.md

@@ -110,6 +110,14 @@ git config --get pullrequest.basebranch # returns the base branch used for the p
 
 #### Parameters
 
+* `git.depth`: *Optional.* If a positive integer is given, *shallow* clone the
+  repository using the `--depth` option. 
+
+* `git.submodules`: *Optional.* If `none`, submodules will not be
+  fetched. If specified as a list of paths, only the given paths will be
+  fetched. If not specified, or if `all` is explicitly specified, all
+  submodules are fetched.
+
 * `fetch_merge`: *Optional*. If set to `true`, it will fetch what the result of PR
   would be otherwise it will fetch the origin branch.
   Defaults to `false`.

assets/lib/commands/base.rb

@@ -7,7 +7,6 @@
 require 'octokit'
 require_relative '../input'
 
-
 module Commands
   class Base
     attr_reader :input

assets/lib/commands/in.rb

@@ -15,12 +15,12 @@ def initialize(destination:, input: Input.instance)
     end
 
     def output
-      id = pr['number']
+      id         = pr['number']
       branch_ref = "pr-#{pr['head']['ref']}"
 
       raise 'PR has merge conflicts' if pr['mergeable'] == false && fetch_merge
 
-      system("git clone --depth 1 #{uri} #{destination} 1>&2")
+      system("git clone #{depth_flag} #{uri} #{destination} 1>&2")
 
       raise 'git clone failed' unless $CHILD_STATUS.exitstatus.zero?
 
@@ -29,12 +29,20 @@ def output
 
         system <<-BASH
           git checkout #{branch_ref} 1>&2
-          git submodule update --init --recursive 1>&2
           git config --add pullrequest.url #{pr['html_url']} 1>&2
           git config --add pullrequest.id #{pr['number']} 1>&2
           git config --add pullrequest.branch #{pr['head']['ref']} 1>&2
           git config --add pullrequest.basebranch #{pr['base']['ref']} 1>&2
         BASH
+
+        case input.params.git.submodules
+        when 'all', nil
+          system("git submodule update --init --recursive #{depth_flag} 1>&2")
+        when Array
+          input.params.git.submodules.each do |path|
+            system("git submodule update --init --recursive #{depth_flag} #{path} 1>&2")
+          end
+        end
       end
 
       {
@@ -64,6 +72,14 @@ def remote_ref
     def fetch_merge
       input.params.fetch_merge
     end
+
+    def depth_flag
+      if depth = input.params.git.depth
+        "--depth #{depth}"
+      else
+        '--depth 1'
+      end
+    end
   end
 end
 

assets/lib/input.rb

@@ -12,6 +12,10 @@ def method
     def merge
       Merge.new(self['merge'] || {})
     end
+
+    def git
+      OpenStruct.new(self['git'] || {})
+    end
   end
 
   def self.instance(payload: nil)

spec/commands/in_spec.rb

@@ -156,4 +156,57 @@ def dest_dir
       end
     end
   end
+
+  fcontext 'with specific `git` params' do
+    before do
+      stub_json('https://api.github.com:443/repos/jtarchie/test/pulls/1',
+                html_url: 'http://example.com', number: 1,
+                head: { ref: 'foo' },
+                base: { ref: 'master' })
+    end
+
+    def expect_arg(*args)
+      allow_any_instance_of(Commands::In).to receive(:system).and_call_original
+      expect_any_instance_of(Commands::In).to receive(:system).with(*args).and_call_original
+    end
+
+    def dont_expect_arg(*args)
+      allow_any_instance_of(Commands::In).to receive(:system).and_call_original
+      expect_any_instance_of(Commands::In).not_to receive(:system).with(*args).and_call_original
+    end
+
+    it 'gets all the submodules' do
+      expect_arg /git submodule update --init --recursive/
+      get('version' => { 'ref' => @ref, 'pr' => '1' }, 'source' => { 'uri' => git_uri, 'repo' => 'jtarchie/test' }, 'params' => {})
+    end
+
+    it 'gets all the submodules explicitly' do
+      expect_arg /git submodule update --init --recursive/
+      get('version' => { 'ref' => @ref, 'pr' => '1' }, 'source' => { 'uri' => git_uri, 'repo' => 'jtarchie/test' }, 'params' => { 'git' => { 'submodules' => 'all' } })
+    end
+
+    it 'gets no submodules' do
+      dont_expect_arg /git submodule update --init --recursive/
+      get('version' => { 'ref' => @ref, 'pr' => '1' }, 'source' => { 'uri' => git_uri, 'repo' => 'jtarchie/test' }, 'params' => { 'git' => { 'submodules' => 'none' } })
+    end
+
+    it 'get submodules with paths' do
+      expect_arg /git submodule update --init --recursive --depth 1 path1/
+      expect_arg /git submodule update --init --recursive --depth 1 path2/
+      get('version' => { 'ref' => @ref, 'pr' => '1' }, 'source' => { 'uri' => git_uri, 'repo' => 'jtarchie/test' }, 'params' => { 'git' => { 'submodules' => %w(path1 path2) } })
+    end
+
+    it 'checkouts everything by depth' do
+      expect_arg /git submodule update --init --recursive --depth 100 path1/
+      expect_arg /git clone --depth 100/
+      get('version' => { 'ref' => @ref, 'pr' => '1' },
+          'source' => { 'uri' => git_uri, 'repo' => 'jtarchie/test' },
+          'params' => {
+            'git' => {
+              'submodules' => %w(path1 path2),
+              'depth' => 100
+            }
+          })
+    end
+  end
 end