license_finder 1.0.0.0-java → 1.1.1-java

data/features/step_definitions/cocoapod_steps.rb

@@ -0,0 +1,8 @@
+Given(/^A Podfile with dependencies$/) do
+  @user = ::DSL::User.new
+  @user.create_cocoapods_app
+end
+
+Then(/^I should see a CocoaPods dependency with a license$/) do
+  @user.should be_seeing_line "ABTest, 0.0.5, MIT"
+end

data/features/step_definitions/configure_bundler_groups_steps.rb

@@ -0,0 +1,30 @@
+Given(/^I have an app that depends on a gem in the test bundler group$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_gem 'gpl_gem', license: 'GPL'
+  @user.depend_on_local_gem 'gpl_gem', groups: ['test']
+end
+
+When(/^I ignore the test group$/) do
+  @user.execute_command('license_finder ignored_bundler_group add test')
+end
+
+When(/^I stop ignoring the test group$/) do
+  @user.execute_command('license_finder ignored_bundler_group remove test')
+end
+
+When(/^I get the ignored groups$/) do
+  @user.execute_command('license_finder ignored_bundler_group list')
+end
+
+Then(/^I should not see the test gem in the output$/) do
+  @user.should_not be_seeing 'gpl_gem'
+end
+
+Then(/^I should see the test group in the output$/) do
+  @user.should be_seeing 'test'
+end
+
+Then(/^I should not see the test group in the output$/) do
+  @user.should_not be_seeing 'test'
+end

data/features/step_definitions/configure_ignore_dependencies.rb

@@ -0,0 +1,35 @@
+Given(/^I have an app that depends on bundler$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_gem 'bundler_faker', license: 'Whatever'
+  @user.depend_on_local_gem 'bundler_faker', groups: ['test', 'development', 'production']
+  @user.create_gem 'gpl_gem', license: 'GPL'
+  @user.depend_on_local_gem 'gpl_gem', groups: ['test']
+end
+
+Given(/^I ignore the bundler dependency$/) do
+  @user.execute_command('license_finder ignored_dependencies add bundler_faker')
+end
+
+When(/^I get the ignored dependencies$/) do
+  @user.execute_command('license_finder ignored_dependencies list')
+end
+
+Then(/^I should see 'bundler' in the output$/) do
+  expect(@user).to be_seeing 'bundler_faker'
+end
+
+Then(/^the bundler dependency is not listed as an action item$/) do
+  @user.execute_command('license_finder > /dev/null')
+  @user.execute_command('license_finder action_items')
+  expect(@user).not_to be_seeing 'bundler_faker'
+end
+
+Then(/^I should not see 'bundler' in the dependency docs$/)do
+  @user.execute_command('license_finder')
+  dependencies_csv_path =  @user.app_path.join('doc', 'dependencies.csv')
+  dependencies_csv = File.open(dependencies_csv_path, 'r')
+
+  expect(dependencies_csv.read).not_to match /bundler_faker/
+end
+

data/features/step_definitions/configure_whitelist_steps.rb

@@ -0,0 +1,45 @@
+Given(/^I have an app that depends on an MIT license$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem 'mit_gem', license: 'MIT'
+end
+
+Given(/^I have an app that depends on an BSD license$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem 'bsd_gem', license: 'BSD'
+end
+
+When(/^I whitelist the BSD license$/) do
+  @user.execute_command 'license_finder whitelist add BSD'
+end
+
+When(/^I whitelist the Expat license$/) do
+  @user.execute_command 'license_finder whitelist add Expat'
+end
+
+When(/^I view the whitelisted licenses$/) do
+  @user.execute_command 'license_finder whitelist list'
+end
+
+When(/^I remove Expat from the whitelist$/) do
+  @user.execute_command 'license_finder whitelist remove Expat'
+end
+
+Then(/^I should not see a MIT licensed gem unapproved$/) do
+  @user.execute_command 'license_finder --quiet'
+  @user.should_not be_seeing 'mit_gem'
+end
+
+Then(/^I should see Expat in the output$/) do
+  @user.should be_seeing 'Expat'
+end
+
+Then(/^I should not see Expat in the output$/) do
+  @user.should_not be_seeing 'Expat'
+end
+
+Then(/^I should not see a BSD licensed gem unapproved$/) do
+  @user.execute_command 'license_finder --quiet'
+  @user.should_not be_seeing 'bsd_gem'
+end

data/features/step_definitions/gradle_steps.rb

@@ -4,5 +4,5 @@ Given(/^A build.gradle file with dependencies$/) do
 end
 
 Then(/^I should see a Gradle dependency with a license$/) do
-  @output.should =~ /^junit, 4.11, Common Public License Version 1.0$/
-end
+  @user.should be_seeing_line "junit, 4.11, Common Public License Version 1.0"
+end

data/features/step_definitions/manually_added_steps.rb

@@ -0,0 +1,28 @@
+Given(/^I have an app and a JS dependency$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.execute_command 'license_finder dependencies add MIT my_js_dep 1.2.3'
+end
+
+When(/^I add my JS dependency$/) do
+  @user.execute_command 'license_finder dependencies add MIT my_js_dep 1.2.3'
+end
+
+When(/^I add my JS dependency with an approval flag$/) do
+  @user.execute_command 'license_finder dependencies add --approve MIT my_js_dep 1.2.3'
+  @user.should be_seeing "The my_js_dep dependency has been added and approved"
+end
+
+When(/^I remove my JS dependency$/) do
+  @user.execute_command 'license_finder dependencies remove my_js_dep'
+end
+
+Then(/^I should see the JS dependency in the console output$/) do
+  @user.execute_command 'license_finder --quiet'
+  @user.should be_seeing 'my_js_dep, 1.2.3, MIT'
+end
+
+Then(/^I should not see the JS dependency in the console output$/) do
+  @user.execute_command 'license_finder --quiet'
+  @user.should_not be_seeing 'my_js_dep, 1.2.3, MIT'
+end

data/features/step_definitions/manually_approved_steps.rb

@@ -0,0 +1,24 @@
+Given(/^I have an app that depends on a GPL licensed gem$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem "gpl_gem", license: "GPL"
+end
+
+When(/^I approve that gem$/) do
+  @user.execute_command "license_finder"
+  @user.should be_seeing "gpl_gem"
+  @user.execute_command "license_finder approve gpl_gem --approver 'Julian' --message 'We really need this'"
+  @user.execute_command "license_finder --quiet"
+end
+
+Then(/^I should not see that gem in the console output$/) do
+  @user.should_not be_seeing "gpl_gem"
+end
+
+Then(/^I should see that gem approved in dependencies\.html$/) do
+  @user.in_gem_html("gpl_gem") do |gpl_gem|
+    gpl_gem[:class].split(' ').should include "approved"
+    gpl_gem.should have_content "Julian"
+    gpl_gem.should have_content "We really need this"
+  end
+end

data/features/step_definitions/manually_assigned_license_steps.rb

@@ -0,0 +1,34 @@
+Given(/^I have an app that depends on a few gems without known licenses$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem 'other_gem', version: '1.0', license: 'other'
+  @user.create_and_depend_on_gem 'control_gem', version: '1.0', license: 'other'
+end
+
+When(/^I set one gem's license to MIT from the command line$/) do
+  @user.execute_command 'license_finder --quiet'
+  @user.execute_command 'license_finder license MIT other_gem'
+  @user.execute_command 'license_finder --quiet'
+end
+
+Then(/^I should see that gem's license set to MIT$/) do
+  @user.should be_seeing 'other_gem, 1.0, MIT'
+end
+
+Then(/^I should see other gems have not changed their licenses$/) do
+  @user.should be_seeing 'control_gem, 1.0, other'
+end
+
+Given(/^I have an app that depends on a manually licensed gem$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem 'changed_gem', license: 'MIT'
+  @user.execute_command "license_finder --quiet"
+  @user.execute_command "license_finder license Ruby changed_gem"
+  @user.should be_seeing_something_like /changed_gem.*Ruby/
+end
+
+Then(/^the gem should keep its manually assigned license$/) do
+  @user.should be_seeing_something_like /changed_gem.*ruby/
+end
+

data/features/step_definitions/maven_steps.rb

@@ -4,5 +4,5 @@ Given(/^A pom file with dependencies$/) do
 end
 
 Then(/^I should see a Maven dependency with a license$/) do
-  @output.should =~ /^junit, 4.11, Common Public License Version 1.0$/
-end
+  @user.should be_seeing_line "junit, 4.11, Common Public License Version 1.0"
+end

data/features/step_definitions/node_steps.rb

@@ -4,5 +4,5 @@ Given(/^A package file with dependencies$/) do
 end
 
 Then(/^I should see a Node dependency with a license$/) do
-  @output.should =~ /^http-server, 0.6.1, MIT$/
-end
+  @user.should be_seeing_line "http-server, 0.6.1, MIT"
+end

data/features/step_definitions/python_steps.rb

@@ -4,5 +4,5 @@ Given(/^A requirements file with dependencies$/) do
 end
 
 Then(/^I should see a Python dependency with a license$/) do
-  @output.should =~ /^argparse, 1.2.1, Python Software Foundation License$/
+  @user.should be_seeing_line "argparse, 1.2.1, Python Software Foundation License"
 end

data/features/step_definitions/report_csv_steps.rb

@@ -0,0 +1,20 @@
+Given(/^I have an app that depends on a gem with license and version details$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem('info_gem', license: 'MIT', version: '1.1.1')
+end
+
+Given(/^I have a dependencies\.txt file$/) do
+  @user.app_path("doc").mkpath
+
+  @user.app_path("doc/dependencies.txt").open('w+') { |file| file.puts("Legacy text file") }
+end
+
+Then(/^I should see those version and license details in the dependencies\.csv file$/) do
+  @user.app_path("doc/dependencies.csv").read.should include "info_gem, 1.1.1, MIT"
+end
+
+Then(/^I should see dependencies\.txt replaced by dependencies\.csv$/) do
+  @user.app_path("doc/dependencies.txt").should_not be_exist
+  @user.app_path("doc/dependencies.csv").should be_exist
+end

data/features/step_definitions/report_html_steps.rb

@@ -0,0 +1,60 @@
+Given(/^my app depends on a gem with specific details$/) do
+  @gem_name = "mit_licensed_gem"
+  @gem_homepage = "http://mit_licensed_gem.github.com"
+  @table = {
+    license:       "MIT",
+    summary:       "mit is cool",
+    description:   "seriously",
+    version:       "0.0.1",
+    bundler_group: "test"
+  }
+  @user.create_gem(@gem_name,
+    license:     @table[:license],
+    summary:     @table[:summary],
+    description: @table[:description],
+    version:     @table[:version],
+    homepage:    @gem_homepage,
+  )
+  @user.depend_on_local_gem(@gem_name, groups: [@table[:bundler_group]])
+end
+
+Given(/^my app depends on MIT and GPL licensed gems$/) do
+  @user.create_and_depend_on_gem 'gpl_licensed_gem', license: "GPL"
+  @user.create_and_depend_on_gem 'mit_licensed_gem', license: "MIT"
+end
+
+When(/^I whitelist the MIT license$/) do
+  @user.configure_license_finder_whitelist ["MIT"]
+  @user.execute_command "license_finder --quiet"
+end
+
+Then(/^I should see my specific gem details listed in the html$/) do
+  @user.in_gem_html(@gem_name) do |section|
+    section.find("a[href='#{@gem_homepage}']", text: @gem_name).should be
+    @table.values.each do |property_value|
+      section.should have_content property_value
+    end
+  end
+end
+
+Then(/^I should see the GPL gem unapproved in html$/) do
+  is_html_status?('gpl_licensed_gem', 'unapproved')
+end
+
+Then(/^the MIT gem approved in html$/) do
+  is_html_status?('mit_licensed_gem', 'approved')
+end
+
+Then(/^I should see only see GPL liceneses as unapproved in the html$/) do
+  @user.in_html do |page|
+    page.should have_content '1 GPL'
+    action_items = page.find('.action-items')
+    action_items.should have_content '(GPL)'
+  end
+end
+
+def is_html_status?(gem, approval)
+  @user.in_gem_html(gem) do |gpl_gem|
+    gpl_gem[:class].split(' ').should include approval
+  end
+end

data/features/step_definitions/shared_steps.rb

@@ -5,26 +5,26 @@ require 'capybara'
 
 ########## COMMON STEPS ##########
 
-Given(/^I have an app with license finder$/) do
+Given(/^I have an app$/) do
   @user = ::DSL::User.new
-  @user.create_nonrails_app
+  @user.create_ruby_app
 end
 
 When(/^I run license_finder$/) do
-  @output = @user.execute_command "license_finder --quiet"
+  @user.execute_command "license_finder --quiet"
 end
 
-When(/^I whitelist MIT, New BSD, Apache 2.0, Ruby, and other licenses$/) do
+When(/^I whitelist everything I can think of$/) do
   @user.configure_license_finder_whitelist ["MIT","other","New BSD","Apache 2.0","Ruby"]
-  @output = @user.execute_command "license_finder --quiet"
+  @user.execute_command "license_finder --quiet"
 end
 
 Then(/^I should see the project name (\w+) in the html$/) do |project_name|
-  html = File.read(@user.dependencies_html_path)
-  page = Capybara.string(html)
-  title = page.find("h1")
+  @user.in_html do |page|
+    title = page.find("h1")
 
-  title.should have_content project_name
+    title.should have_content project_name
+  end
 end
 
 
@@ -33,8 +33,8 @@ module DSL
     def create_python_app
       reset_projects!
 
-      `mkdir -p #{app_path}`
-      `cd #{app_path} && touch requirements.txt`
+      app_path.mkpath
+      shell_out("cd #{app_path} && touch requirements.txt")
 
       add_pip_dependency('argparse==1.2.1')
 
@@ -44,8 +44,8 @@ module DSL
     def create_node_app
       reset_projects!
 
-      `mkdir -p #{app_path}`
-      `cd #{app_path} && touch package.json`
+      app_path.mkpath
+      shell_out("cd #{app_path} && touch package.json")
 
       add_npm_dependency('http-server', '0.6.1')
 
@@ -55,10 +55,9 @@ module DSL
     def create_maven_app
       reset_projects!
 
-      path = File.expand_path("spec/fixtures/pom.xml")
+      app_path.mkpath
 
-      `mkdir -p #{app_path}`
-      `cd #{app_path} && cp #{path} .`
+      add_maven_dependency
 
       mvn_install
     end
@@ -66,125 +65,129 @@ module DSL
     def create_gradle_app
       reset_projects!
 
-      path = File.expand_path("spec/fixtures/build.gradle")
+      app_path.mkpath
 
-      `mkdir -p #{app_path}`
-      `cd #{app_path} && cp #{path} .`
-      `gradle dependencies`
+      add_gradle_dependency
     end
 
-    def create_nonrails_app
+    def create_ruby_app
       reset_projects!
 
-      `cd #{projects_path} && bundle gem #{app_name}`
+      shell_out("cd #{projects_path} && bundle gem #{app_name}")
 
-      add_gem_dependency('license_finder', :path => root_path)
+      add_gem_dependency('license_finder', path: root_path.to_s)
 
-      bundle_app
+      bundle_install
     end
 
-    def create_rails_app
+    def create_cocoapods_app
       reset_projects!
 
-      `bundle exec rails new #{app_path} --skip-bundle`
-
-      add_gem_dependency('license_finder', :path => root_path)
-
-      bundle_app
-    end
-
-    def update_gem(name, attrs)
-      file_contents = YAML.load(File.read(dependencies_file_path))
+      app_path.mkpath
 
-      index = file_contents.index { |gem| gem['name'] == name }
-      file_contents[index].merge!(attrs)
+      add_pod_dependency
 
-      File.open(dependencies_file_path, "w") do |f|
-        f.puts file_contents.to_yaml
-      end
+      pod_install
     end
 
-    def append_to_file(filename, text)
-      File.open(File.join(app_path, filename), "a") do |f|
-        f.puts text
-      end
+    def create_and_depend_on_gem(gem_name, options)
+      create_gem(gem_name, options)
+      depend_on_local_gem(gem_name)
     end
 
-    def add_dependency_to_app(gem_name, options={})
-      license = options.fetch(:license)
-      summary = options.fetch(:summary, "")
-      description = options.fetch(:description, "")
-      bundler_groups = options.fetch(:bundler_groups, "").to_s.split(',').map(&:strip)
-      version = options[:version] || "0.0.0"
-      homepage = options[:homepage]
+    def create_gem(gem_name, options)
+      gem_dir = projects_path.join(gem_name)
 
-      gem_dir = File.join(projects_path, gem_name)
-
-      FileUtils.mkdir(gem_dir)
-      File.open(File.join(gem_dir, "#{gem_name}.gemspec"), 'w') do |file|
-        file.write <<-GEMSPEC
-          Gem::Specification.new do |s|
-            s.name = "#{gem_name}"
-            s.version = "#{version}"
-            s.author = "Cucumber"
-            s.summary = "#{summary}"
-            s.license = "#{license}"
-            s.description = "#{description}"
-            s.homepage = "#{homepage}"
-          end
-        GEMSPEC
+      gem_dir.mkpath
+      gem_dir.join("#{gem_name}.gemspec").open('w') do |file|
+        file.write gemspec_string(gem_name, options)
       end
+    end
 
-      gem_options = {}
-      gem_options[:path] = File.join(projects_path, gem_name)
-      gem_options[:groups] = bundler_groups unless bundler_groups.empty?
+    def depend_on_local_gem(gem_name, options={})
+      gem_dir = projects_path.join(gem_name)
+      options[:path] = gem_dir.to_s
 
-      add_gem_dependency(gem_name, gem_options)
+      add_gem_dependency(gem_name, options)
 
-      bundle_app
+      bundle_install
     end
 
     def configure_license_finder_whitelist(whitelisted_licenses=[])
-      FileUtils.mkdir_p(config_path)
-      File.open(File.join(config_path, "license_finder.yml"), "w") do |f|
+      config_path.mkpath
+      config_file.open("w") do |f|
         f.write({'whitelist' => whitelisted_licenses}.to_yaml)
       end
     end
 
     def execute_command(command)
       ::Bundler.with_clean_env do
-        @output = `cd #{app_path} && bundle exec #{command}`
+        @output = shell_out("cd #{app_path} && bundle exec #{command}", true)
       end
+    end
+
+    def seeing?(content)
+      @output.include? content
+    end
+
+    def seeing_line?(content)
+      seeing_something_like? /^#{Regexp.escape content}$/
+    end
 
-      @output
+    def seeing_something_like?(regex)
+      @output =~ regex
     end
 
     def app_path(sub_directory = nil)
-      path = app_path = Pathname.new(File.join(projects_path, app_name)).cleanpath.to_s
+      path = base_path = projects_path.join(app_name).cleanpath
 
       if sub_directory
-        path = Pathname.new(File.join(app_path, sub_directory)).cleanpath.to_s
+        path = base_path.join(sub_directory).cleanpath
 
-        raise "#{name} is outside of the app" unless path =~ %r{^#{app_path}/}
+        raise "#{sub_directory} is outside of the app" unless path.to_s =~ %r{^#{base_path}/}
       end
 
       path
     end
 
     def config_path
-      File.join(app_path, 'config')
+      app_path('config')
+    end
+
+    def config_file
+      config_path.join("license_finder.yml")
     end
 
-    def doc_path
-      File.join(app_path, 'doc')
+    def in_html
+      yield Capybara.string(app_path('doc/dependencies.html').read)
     end
 
-    def dependencies_file_path
-      File.join(doc_path, 'dependencies.yml')
+    def in_gem_html(gem_name)
+      in_html do |page|
+        yield page.find("##{gem_name}")
+      end
     end
 
-    def dependencies_html_path
-      File.join(doc_path, 'dependencies.html')
+    private
+
+    def gemspec_string(gem_name, options)
+      license = options.fetch(:license)
+      summary = options.fetch(:summary, "")
+      description = options.fetch(:description, "")
+      version = options[:version] || "0.0.0"
+      homepage = options[:homepage]
+
+      <<-GEMSPEC
+      Gem::Specification.new do |s|
+        s.name = "#{gem_name}"
+        s.version = "#{version}"
+        s.author = "Cucumber"
+        s.summary = "#{summary}"
+        s.license = "#{license}"
+        s.description = "#{description}"
+        s.homepage = "#{homepage}"
+      end
+      GEMSPEC
     end
 
     def add_gem_dependency(name, options = {})
@@ -204,41 +207,53 @@ module DSL
       add_to_package(line)
     end
 
-    def bundle_app
+    def add_maven_dependency
+      path = fixtures_path.join("pom.xml")
+      shell_out("cp #{path} #{app_path}")
+    end
+
+    def add_gradle_dependency
+      path = fixtures_path.join("build.gradle")
+      shell_out("cd #{app_path} && cp #{path} .")
+    end
+
+    def add_pod_dependency
+      path = fixtures_path.join("Podfile")
+      shell_out("cp #{path} #{app_path}")
+    end
+
+    def bundle_install
       ::Bundler.with_clean_env do
-        `bundle install --gemfile=#{File.join(app_path, "Gemfile")} --path=#{bundle_path}`
+        shell_out("bundle install --gemfile=#{app_path.join("Gemfile")} --path=#{sandbox_path.join("bundle")}")
       end
     end
 
     def pip_install
-      `cd #{app_path} && pip install -r requirements.txt`
+      shell_out("cd #{app_path} && pip install -r requirements.txt")
     end
 
     def npm_install
-      `cd #{app_path} && npm install 2>/dev/null`
+      shell_out("cd #{app_path} && npm install 2>/dev/null")
     end
 
     def mvn_install
-      `cd #{app_path} && mvn install`
+      shell_out("cd #{app_path} && mvn install")
     end
 
-    def modifying_dependencies_file
-      FileUtils.mkdir_p(File.dirname(dependencies_file_path))
-      File.open(dependencies_file_path, 'w+') { |f| yield f }
+    def pod_install
+      shell_out("cd #{app_path} && pod install --no-integrate")
     end
 
-    private
-
     def add_to_gemfile(line)
-      `echo #{line.inspect} >> #{File.join(app_path, "Gemfile")}`
+      shell_out("echo #{line.inspect} >> #{app_path.join("Gemfile")}")
     end
 
     def add_to_requirements(line)
-      `echo #{line.inspect} >> #{File.join(app_path, "requirements.txt")}`
+      shell_out("echo #{line.inspect} >> #{app_path.join("requirements.txt")}")
     end
 
     def add_to_package(line)
-      `echo #{line.inspect} >> #{File.join(app_path, "package.json")}`
+      shell_out("echo #{line.inspect} >> #{app_path.join("package.json")}")
     end
 
     def app_name
@@ -246,24 +261,30 @@ module DSL
     end
 
     def sandbox_path
-      File.join(root_path, "tmp")
+      root_path.join("tmp")
     end
 
     def projects_path
-      File.join(sandbox_path, "projects")
+      sandbox_path.join("projects")
     end
 
-    def bundle_path
-      File.join(sandbox_path, "bundle")
+    def fixtures_path
+      root_path.join("spec", "fixtures")
     end
 
     def reset_projects!
-      `rm -rf #{projects_path}`
-      `mkdir -p #{projects_path}`
+      shell_out("rm -rf #{projects_path}")
+      projects_path.mkpath
     end
 
     def root_path
-      Pathname.new(File.join(File.dirname(__FILE__), "..", "..")).realpath.to_s
+      Pathname.new(__FILE__).dirname.join("..", "..").realpath
+    end
+
+    def shell_out(command, allow_failures = false)
+      output = `#{command}`
+      raise RuntimeError.new("command failed #{command}") unless $?.success? || allow_failures
+      output
     end
   end
 end