license_finder 2.0.4 → 2.1.0.rc1

data/lib/license_finder/reports/merged_report.rb

@@ -0,0 +1,13 @@
+module LicenseFinder
+  class MergedReport < CsvReport
+    AVAILABLE_COLUMNS = AVAILABLE_COLUMNS + ['subproject_paths']
+
+    def initialize(dependencies, options = {})
+      super(dependencies, options.merge(columns: %w(name version licenses subproject_paths)))
+    end
+
+    def format_subproject_paths(merged_dep)
+      merged_dep.subproject_paths.join(self.class::COMMA_SEP)
+    end
+  end
+end

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "2.0.4"
+  VERSION = "2.1.0.rc1"
 end

data/license_finder.gemspec

@@ -1,5 +1,8 @@
-require './lib/license_finder/platform'
-require './lib/license_finder/version'
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'license_finder/platform'
+require 'license_finder/version'
 
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
@@ -42,6 +45,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-its"
+  s.add_development_dependency "fakefs"
   s.add_development_dependency "pry"
   s.add_development_dependency "rspec", "~> 3"
   s.add_development_dependency "capybara", "~> 2.0.0"

data/spec/dummy_app/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+ruby '2.1.5'
+
+gem 'bundler'
+gem 'httparty'

data/spec/fixtures/composite/nested_project/.envrc

@@ -0,0 +1,8 @@
+project_go_root="$(dirname ${BASH_SOURCE[0]})/../../../../"
+
+cd $project_go_root
+  if [ $(basename $PWD) == "cf-release" ]
+  then
+    export GOPATH=$GOPATH:$PWD
+  fi
+cd -

data/spec/fixtures/composite/nested_project/src/github.com/pivotal/foo/Godeps/Godeps.json

@@ -0,0 +1,16 @@
+{
+	"ImportPath": "github.com/pivotal/foo",
+	"GoVersion": "go1.4.2",
+	"Deps": [
+		{
+			"ImportPath": "github.com/onsi/ginkgo",
+			"Comment": "v1.2.0-6-gd981d36",
+			"Rev": "d981d36e9884231afa909627b9c275e4ba678f90"
+		},
+		{
+			"ImportPath": "github.com/onsi/gomega",
+			"Comment": "v1.0-50-gd6c945f",
+			"Rev": "d6c945f9fdbf6cad99e85b0feff591caa268e0db"
+		}
+	]
+}

data/spec/fixtures/composite/nested_project/src/github.com/pivotal/foo/Godeps/Readme

@@ -0,0 +1,5 @@
+This directory tree is generated automatically by godep.
+
+Please do not edit.
+
+See https://github.com/tools/godep for more information.

data/spec/fixtures/composite/nested_project/src/github.com/pivotal/foo/foo.go

@@ -0,0 +1,6 @@
+package foo
+
+import (
+  . "github.com/onsi/ginkgo"
+  . "github.com/onsi/gomega"
+)

data/spec/lib/license_finder/cli/approvals_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "#add" do

data/spec/lib/license_finder/cli/blacklist_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe Blacklist do
+      let(:decisions) { Decisions.new }
+
+      before do
+       allow(Decisions).to receive(:fetch_saved) { decisions }
+      end
+
+      describe "list" do
+        it "shows the blacklist of licenses" do
+          decisions.blacklist("MIT")
+
+          expect(capture_stdout { subject.list }).to match /MIT/
+        end
+      end
+
+      describe "add" do
+        it "adds the specified license to the blacklist" do
+          silence_stdout do
+            subject.add("test")
+          end
+          expect(subject.decisions.blacklisted).to eq [License.find_by_name("test")].to_set
+        end
+
+        it "adds multiple licenses to the blacklist" do
+          silence_stdout do
+            subject.add("test", "rest")
+          end
+          expect(subject.decisions.blacklisted).to eq [
+            License.find_by_name("test"),
+            License.find_by_name("rest")
+          ].to_set
+        end
+      end
+
+      describe "remove" do
+        it "removes the specified license from the blacklist" do
+          silence_stdout do
+            subject.add("test")
+            subject.remove("test")
+          end
+          expect(subject.decisions.blacklisted).to be_empty
+        end
+
+        it "removes multiple licenses from the blacklist" do
+          silence_stdout do
+            subject.add("test", "rest")
+            subject.remove("test", "rest")
+          end
+          expect(subject.decisions.blacklisted).to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/lib/license_finder/cli/dependencies_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "add" do

data/spec/lib/license_finder/cli/ignored_dependencies_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "list" do

data/spec/lib/license_finder/cli/ignored_groups_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "list" do

data/spec/lib/license_finder/cli/licenses_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "add" do

data/spec/lib/license_finder/cli/main_spec.rb

@@ -11,22 +11,66 @@ module LicenseFinder
           packages: packages
         )
       end
+      let(:configuration) { double(:configuration, valid_project_path?: true) }
+      let(:license_finder_instance) { double(:license_finder, unapproved: [unapproved_dependency], blacklisted: [], project_name: 'taco stand', config: configuration) }
+      let(:license) { double(:license, name: "thing") }
+      let(:unapproved_dependency) { double(:dependency, name: "a dependency", version: "2.4.1", missing?: false, licenses: [license]) }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
         allow(DecisionApplier).to receive(:new) { decision_applier }
       end
 
       describe "default" do
         it "checks for action items" do
           decisions.add_package("a dependency", nil)
-
+          expect_any_instance_of(LicenseFinder::Core).to receive(:unapproved).and_return([unapproved_dependency])
           silence_stdout do
             expect { described_class.start(["--quiet"]) }.to raise_error(SystemExit)
           end
         end
       end
 
+      describe "cli options" do
+        let(:config_options) { [
+          "--decisions_file=whatever.yml",
+          "--project_path=../other_project",
+          "--gradle_command=do_things",
+          "--rebar_command=do_other_things",
+          "--rebar_deps_dir=rebar_dir",
+          "--save"
+        ] }
+        let(:logger_options) {
+          [
+            '--quiet',
+            '--debug'
+          ]
+        }
+        let(:parsed_config) { {
+          decisions_file: 'whatever.yml',
+          project_path: '../other_project',
+          gradle_command: 'do_things',
+          rebar_command: 'do_other_things',
+          rebar_deps_dir: 'rebar_dir',
+          save: 'license_report',
+          logger: {}
+        } }
+
+        it "passes the config options to the new LicenseFinder::Core instance" do
+          expect(LicenseFinder::Core).to receive(:new).with(parsed_config).and_return(license_finder_instance)
+          silence_stdout do
+            expect { described_class.start(config_options) }.to raise_error(SystemExit)
+          end
+        end
+
+        it "passes the logger options to the new LicenseFinder::Core instance" do
+          expect(LicenseFinder::Core).to receive(:new).with({logger: {debug: true, quiet: true}}).and_return(license_finder_instance)
+          silence_stdout do
+            expect { described_class.start(logger_options) }.to raise_error(SystemExit)
+          end
+        end
+      end
+
       describe "#report" do
         let(:packages) { [Package.new('one dependency', "1.1")] }
 
@@ -39,20 +83,20 @@ module LicenseFinder
         end
 
         it "will output a specific format" do
-          subject.options = { format: 'markdown' }
+          subject.options = {format: 'markdown'}
 
           expect(report).to include "## Action"
         end
 
         it "will output a custom csv" do
-          subject.options = { format: 'csv', columns: ['name', 'version'] }
+          subject.options = {format: 'csv', columns: ['name', 'version']}
 
           expect(report).to eq "one dependency,1.1\n"
         end
 
         context "in html reports" do
           before do
-            subject.options = { format: 'html' }
+            subject.options = {format: 'html'}
           end
 
           context "when the project has a name" do
@@ -64,18 +108,68 @@ module LicenseFinder
           end
 
           context "when the project has no name" do
-            before { allow(Dir).to receive(:getwd).and_return("/path/to/a_project") }
+            before { allow_any_instance_of(Pathname).to receive(:basename).and_return("a_project") }
 
             it "should default to the directory name" do
               expect(report).to include "a_project"
             end
           end
         end
+
+        context "when the --save option is passed" do
+          it "calls report method and calls save_report" do
+            subject.options = {save: "license_report", format: 'text'}
+            expect(subject).to receive(:report).and_call_original
+            expect(subject).to receive(:save_report)
+
+            subject.report
+          end
+
+          context "when file name is not specified (--save)" do
+            it "creates report that is called the default file name" do
+              provided_by_thor_as_default_name = "license_report" #####FIX ME
+              subject.options = {save: provided_by_thor_as_default_name, format: 'text'}
+              expect(subject).to receive(:report).and_call_original
+              expect(subject).to receive(:save_report).with(instance_of(String), "license_report")
+
+              subject.report
+            end
+
+            it "saves the output report to default file ('license_report.txt') in project root" do
+              mock_file = double(:file)
+              expect(File).to receive(:open).with("license_report.txt", "w").and_yield(mock_file)
+              expect(mock_file).to receive(:write).with("content of file")
+
+              subject.send(:save_report, "content of file", "license_report.txt")
+            end
+          end
+
+          context "when file name is specified (--save='FILENAME')" do
+            it "saves with a specified file name" do
+              subject.options = {save: 'my_report' , format: 'text'}
+              expect(subject).to receive(:report).and_call_original
+              expect(subject).to receive(:save_report).with(instance_of(String), "my_report")
+
+              subject.report
+            end
+          end
+        end
+
+        context "when the --save option is not passed" do
+          it "calls report method and does not call save_report" do
+            subject.options = {format: 'text'}
+            expect(subject).to receive(:report).and_call_original
+            expect(subject).not_to receive(:save_report)
+            expect(subject).to receive(:report_of)
+
+            report
+          end
+        end
       end
 
       describe "#action_items" do
         def action_items
-          subject.options = { quiet: true, format: 'text' }
+          subject.options = {quiet: true, format: 'text'}
           subject.action_items
         end
 
@@ -91,6 +185,18 @@ module LicenseFinder
           end
         end
 
+        context "with blacklisted dependencies" do
+          let(:decisions) { Decisions.new.blacklist('GPLv3')}
+          let(:packages)  { [Package.new('blacklisted', '1.0', spec_licenses: ['GPLv3'])] }
+
+          it "reports blacklisted dependencies" do
+            result = capture_stdout do
+              expect { action_items }.to raise_error(SystemExit)
+            end
+            expect(result).to include "Blacklisted dependencies:\nblacklisted, 1.0, GPLv3"
+          end
+        end
+
         it "reports that all dependencies are approved" do
           result = capture_stdout do
             expect { action_items }.not_to raise_error

data/spec/lib/license_finder/cli/project_name_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "show" do

data/spec/lib/license_finder/cli/whitelist_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       let(:decisions) { Decisions.new }
 
       before do
-        allow(Decisions).to receive(:saved!) { decisions }
+        allow(Decisions).to receive(:fetch_saved) { decisions }
       end
 
       describe "list" do

data/spec/lib/license_finder/configuration_spec.rb

@@ -4,9 +4,31 @@ module LicenseFinder
   describe Configuration do
     describe ".with_optional_saved_config" do
       it "should init and use saved config" do
-        subject = described_class.with_optional_saved_config({}, fixture_path("."))
+        subject = described_class.with_optional_saved_config({project_path: fixture_path(".")})
         expect(subject.gradle_command).to eq('gradlew')
       end
+
+      it "prepends the project_path to the config file path" do
+        subject = described_class.with_optional_saved_config({project_path: "other_directory"})
+        expect(subject.send(:saved_config)).to eq({})
+      end
+    end
+
+    describe "#valid_project_path?" do
+      it "returns false when the path does not exist" do
+        subject = described_class.with_optional_saved_config({project_path: '/path/that/does/not/exist'})
+        expect(subject.valid_project_path?).to be(false)
+      end
+
+      it "returns true when the path exists" do
+        subject = described_class.with_optional_saved_config({project_path: '/'})
+        expect(subject.valid_project_path?).to be(true)
+      end
+
+      it "returns true if the path is not provided" do
+        subject = described_class.with_optional_saved_config({})
+        expect(subject.valid_project_path?).to be(true)
+      end
     end
 
     describe "gradle_command" do
@@ -41,7 +63,7 @@ module LicenseFinder
           {decisions_file: "primary"},
           {"decisions_file" => "secondary"}
         )
-        expect(subject.decisions_file.to_s).to eq "primary"
+        expect(subject.decisions_file_path.to_s).to end_with "primary"
       end
 
       it "accepts saved value" do
@@ -49,7 +71,7 @@ module LicenseFinder
           {decisions_file: nil},
           {"decisions_file" => "secondary"}
         )
-        expect(subject.decisions_file.to_s).to eq "secondary"
+        expect(subject.decisions_file_path.to_s).to end_with "secondary"
       end
 
       it "has default" do
@@ -57,7 +79,44 @@ module LicenseFinder
           {decisions_file: nil},
           {"decisions_file" => nil}
         )
-        expect(subject.decisions_file.to_s).to eq "doc/dependency_decisions.yml"
+        expect(subject.decisions_file_path.to_s).to end_with "doc/dependency_decisions.yml"
+      end
+
+      it "prepends project path to default path if project_path option is set" do
+        subject = described_class.new({project_path: "magic_path"}, {})
+        expect(subject.decisions_file_path.to_s).to end_with "magic_path/doc/dependency_decisions.yml"
+      end
+
+      it "prepends project path to provided value" do
+        subject = described_class.new({decisions_file: "primary",
+            project_path: "magic_path"},
+            {"decisions_file" => "secondary"}
+        )
+        expect(subject.decisions_file_path.to_s).to end_with "magic_path/primary"
+      end
+    end
+
+    describe "rebar_deps_dir" do
+      it "has default" do
+        subject = described_class.new(
+            {rebar_deps_dir: nil},
+            {"rebar_deps_dir" => nil}
+        )
+        expect(subject.rebar_deps_dir.to_s).to end_with "deps"
+      end
+
+      it "prepends project path to default path if project_path option is set" do
+        subject = described_class.new({project_path: "magic_path"}, {})
+        expect(subject.rebar_deps_dir.to_s).to end_with "magic_path/deps"
+      end
+
+      it "prepends project path to provided value" do
+        subject = described_class.new(
+            {rebar_deps_dir: "primary",
+             project_path: "magic_path"},
+            {"rebar_deps_dir" => "secondary"}
+        )
+        expect(subject.rebar_deps_dir.to_s).to end_with "magic_path/primary"
       end
     end
   end