license_finder 1.2 → 2.0.0.rc2

data/Rakefile

@@ -3,31 +3,35 @@ Bundler::GemHelper.install_tasks
 
 require './lib/license_finder/platform'
 require 'rspec/core/rake_task'
-require 'cucumber'
-require 'cucumber/rake/task'
 
 desc "Run all specs in spec/"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.fail_on_error = true
-  t.pattern = "./spec/**/*_spec.rb"
-  t.rspec_opts = %w[--color]
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.fail_on_error = true
+    t.pattern = "./spec/**/*_spec.rb"
+    t.rspec_opts = %w[--color]
+  end
 end
 
-desc "Run all cukes in features/"
-Cucumber::Rake::Task.new(:features) do |t|
-  tags = LicenseFinder::Platform.darwin? ? "" : "--tags ~@ios"
-  t.cucumber_opts = "features --format pretty #{tags}"
+desc "Run all specs in features/"
+task :features do
+  RSpec::Core::RakeTask.new(:features) do |t|
+    t.fail_on_error = true
+    t.pattern = "./features/**/*_spec.rb"
+    opts = %w[--color --format d]
+    opts += LicenseFinder::Platform.darwin? ? [] : %w[--tag ~ios]
+    t.rspec_opts = opts
+  end
 end
 
 desc "Check for non-Ruby development dependencies."
 task :check_dependencies do
-  require "open3"
-
   dependencies = {
     "mvn" => "Maven",
     "npm" => "node.js",
     "pip" => "Python",
-    "gradle" => "Gradle"
+    "gradle" => "Gradle",
+    "bower" => "Bower"
   }
   dependencies["pod"] = "Cocoapods" if LicenseFinder::Platform.darwin?
   satisfied = true

data/features/features/cli_spec.rb

@@ -0,0 +1,43 @@
+require 'feature_helper'
+
+describe "License Finder command line executable" do
+  # As a developer
+  # I want a command-line interface
+  # So that I can manage my application's dependencies and licenses
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "reports unapproved dependencies" do
+    user.create_empty_project
+    user.execute_command("license_finder dependencies add unapproved_gem Whatever")
+
+    user.run_license_finder
+    expect(user).to be_receiving_exit_code(1)
+    expect(user).to be_seeing 'unapproved_gem'
+  end
+
+  specify "reports that all dependencies are approved" do
+    user.create_empty_project
+
+    user.run_license_finder
+    expect(user).to be_receiving_exit_code(0)
+    expect(user).to be_seeing 'All dependencies are approved for use'
+  end
+
+  specify "shows usage and subcommand help" do
+    user.create_empty_project
+
+    user.execute_command "license_finder help"
+    expect(user).to be_seeing 'license_finder help [COMMAND]'
+
+    user.execute_command "license_finder ignored_groups help add"
+    expect(user).to be_seeing 'license_finder ignored_groups add GROUP'
+  end
+
+  it "reports `license_finder`'s license is MIT" do
+    user.create_ruby_app # has license_finder as a dependency
+
+    user.run_license_finder
+    expect(user).to be_seeing_something_like /license_finder.*MIT/
+  end
+end

data/features/features/configure/add_dependencies_spec.rb

@@ -0,0 +1,37 @@
+require 'feature_helper'
+
+describe "Manually Added Dependencies" do
+  # As a developer
+  # I want to be able to manually add dependencies
+  # So that I can track dependencies not managed by Bundler, NPM, etc.
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  before { user.create_empty_project }
+
+  specify "appear in reports" do
+    user.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
+
+    user.run_license_finder
+    expect(user).to be_seeing 'manual_dep, 1.2.3, MIT'
+  end
+
+  specify "can be simultaneously approved" do
+    user.execute_command 'license_finder dependencies add --approve manual Whatever'
+
+    user.run_license_finder
+    expect(user).not_to be_seeing 'manual_dep'
+  end
+
+  specify "appear in the CLI" do
+    user.execute_command 'license_finder dependencies add manual_dep Whatever'
+    expect(user).to be_seeing 'manual_dep'
+
+    user.execute_command 'license_finder dependencies list'
+    expect(user).to be_seeing 'manual_dep'
+
+    user.execute_command 'license_finder dependencies remove manual_dep'
+    user.execute_command 'license_finder dependencies list'
+    expect(user).to_not be_seeing 'manual_dep'
+  end
+end

data/features/features/configure/approve_dependencies_spec.rb

@@ -0,0 +1,30 @@
+require 'feature_helper'
+
+describe "Manually Approved Dependencies" do
+  # As a developer
+  # I want to approve dependencies that do not have whitelisted licenses
+  # So that I can track the dependencies which my business has approved
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  before do
+    user.create_empty_project
+    user.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
+    user.execute_command "license_finder approval add manual_dep --who 'Julian' --why 'We really need this'"
+  end
+
+  specify "do not appear in action items" do
+    user.run_license_finder
+    expect(user).to_not be_seeing "manual_dep"
+  end
+
+  specify "include approval detail in reports" do
+    html = user.view_html
+    expect(html).to be_approved 'manual_dep'
+
+    html.in_dep("manual_dep") do |section|
+      expect(section).to have_content "Julian"
+      expect(section).to have_content "We really need this"
+    end
+  end
+end

data/features/features/configure/assign_licenses_spec.rb

@@ -0,0 +1,20 @@
+require 'feature_helper'
+
+describe "Manually Assigned Licenses" do
+  # As a developer
+  # I want to be able to override the licenses license_finder finds
+  # So that my dependencies all have the correct licenses
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    project = user.create_ruby_app
+    gem = user.create_gem 'mislicensed_dep', license: 'Unknown'
+    project.depend_on gem
+    user.execute_command 'license_finder licenses add mislicensed_dep Known'
+
+    user.run_license_finder
+    expect(user).not_to be_seeing_something_like /mislicensed_dep.*Unknown/
+    expect(user).to be_seeing_something_like /mislicensed_dep.*Known/
+  end
+end

data/features/features/configure/ignore_dependencies_spec.rb

@@ -0,0 +1,35 @@
+require 'feature_helper'
+
+describe "Ignored Dependencies" do
+  # As a developer
+  # I want to ignore certain dependencies
+  # To avoid frequently changing reports about dependencies I know will always be approved
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  before do
+    user.create_empty_project
+    user.execute_command 'license_finder dependencies add ignored_dep Whatever'
+  end
+
+  specify "are excluded from reports" do
+    user.execute_command 'license_finder ignored_dependencies add ignored_dep'
+
+    user.run_license_finder
+    expect(user).to_not be_seeing 'ignored_dep'
+    user.execute_command('license_finder report')
+    expect(user).to_not be_seeing 'ignored_dep'
+  end
+
+  specify "appear in the CLI" do
+    user.execute_command 'license_finder ignored_dependencies add ignored_dep'
+    expect(user).to be_seeing 'ignored_dep'
+
+    user.execute_command 'license_finder ignored_dependencies list'
+    expect(user).to be_seeing 'ignored_dep'
+
+    user.execute_command 'license_finder ignored_dependencies remove ignored_dep'
+    user.execute_command 'license_finder ignored_dependencies list'
+    expect(user).to_not be_seeing 'ignored_dep'
+  end
+end

data/features/features/configure/ignore_groups_spec.rb

@@ -0,0 +1,31 @@
+require 'feature_helper'
+
+describe "Ignored Groups" do
+  # As a developer
+  # I want to ignore certain groups
+  # So that any gems I use in development, or for testing, are automatically approved for use
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are excluded from reports" do
+    project = user.create_ruby_app
+    gem = user.create_gem 'dev_gem', license: 'GPL'
+    project.depend_on gem, groups: ['dev']
+    user.execute_command 'license_finder ignored_group add dev'
+
+    user.run_license_finder
+    expect(user).to_not be_seeing 'dev_gem'
+  end
+
+  specify "appear in the CLI" do
+    user.create_empty_project
+    user.execute_command 'license_finder ignored_group add dev'
+    expect(user).to be_seeing 'dev'
+    user.execute_command 'license_finder ignored_group list'
+    expect(user).to be_seeing 'dev'
+
+    user.execute_command 'license_finder ignored_group remove dev'
+    user.execute_command 'license_finder ignored_group list'
+    expect(user).to_not be_seeing 'dev'
+  end
+end

data/features/features/configure/name_project_spec.rb

@@ -0,0 +1,32 @@
+require 'feature_helper'
+
+describe "Project name" do
+  # As a developer
+  # I want to assign a name for my project
+  # So that the reports show it
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  before { user.create_empty_project }
+
+  specify "appears in the HTML report" do
+    user.execute_command 'license_finder project_name add changed_name'
+
+    expect(user.view_html).to be_titled 'changed_name'
+  end
+
+  specify "defaults to the directory name" do
+    expect(user.view_html).to be_titled 'my_app'
+  end
+
+  specify "appears in the CLI" do
+    user.execute_command 'license_finder project_name add my_proj'
+    expect(user).to be_seeing 'my_proj'
+    user.execute_command 'license_finder project_name show'
+    expect(user).to be_seeing 'my_proj'
+
+    user.execute_command 'license_finder project_name remove'
+    user.execute_command 'license_finder project_name show'
+    expect(user).to_not be_seeing 'my_proj'
+  end
+end

data/features/features/configure/whitelist_licenses_spec.rb

@@ -0,0 +1,40 @@
+require 'feature_helper'
+
+describe "Whitelisted licenses" do
+  # As a developer
+  # I want to whitelist certain OSS licenses that my business has pre-approved
+  # So that any dependencies with those licenses do not show up as action items
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  before { user.create_empty_project }
+
+  specify "approve dependencies with those licenses" do
+    user.execute_command 'license_finder dependencies add bsd_gem BSD'
+    user.execute_command 'license_finder whitelist add BSD'
+
+    user.run_license_finder
+    expect(user).to_not be_seeing 'bsd_gem'
+  end
+
+  specify "approve dependencies with any of those licenses" do
+    user.execute_command 'license_finder dependencies add dep_with_many_licenses GPL'
+    user.execute_command 'license_finder licenses add dep_with_many_licenses MIT'
+    user.execute_command 'license_finder whitelist add GPL'
+
+    user.run_license_finder
+    expect(user).not_to be_seeing 'dep_with_many_licenses'
+  end
+
+  specify "are shown in the CLI" do
+    user.execute_command 'license_finder whitelist add Expat'
+    expect(user).to be_seeing 'Expat'
+    user.execute_command 'license_finder whitelist list'
+    expect(user).to be_seeing 'MIT'
+
+    user.execute_command 'license_finder whitelist remove Expat'
+    expect(user).to be_seeing 'Expat'
+    user.execute_command 'license_finder whitelist list'
+    expect(user).to_not be_seeing 'MIT'
+  end
+end

data/features/features/package_managers/bower_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "Bower Dependencies" do
+  # As a JS developer
+  # I want to be able to manage Bower dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::BowerProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line "gmaps, 0.2.30, MIT"
+  end
+end

data/features/features/package_managers/cocoapods_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "CocoaPods Dependencies", ios: true do
+  # As a Mac developer
+  # I want to be able to manage CocoaPods dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::CocoaPodsProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line "ABTest, 0.0.5, MIT"
+  end
+end

data/features/features/package_managers/gradle_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "Gradle Dependencies" do
+  # As a Java developer
+  # I want to be able to manage Gradle dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::GradleProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
+  end
+end

data/features/features/package_managers/maven_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "Maven Dependencies" do
+  # As a Java developer
+  # I want to be able to manage Maven dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::MavenProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
+  end
+end

data/features/features/package_managers/npm_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "NPM Dependencies" do
+  # As a Node developer
+  # I want to be able to manage NPM dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::NpmProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line "http-server, 0.6.1, MIT"
+  end
+end

data/features/features/package_managers/pip_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "Pip Dependencies" do
+  # As a Python developer
+  # I want to be able to manage Pip dependencies
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::PipProject.create
+    user.run_license_finder
+    expect(user).to be_seeing_line 'argparse, 1.2.1, "Python Software Foundation License"'
+  end
+end

data/features/features/report/csv_spec.rb

@@ -0,0 +1,17 @@
+require 'feature_helper'
+
+describe "CSV report" do
+  # As a non-technical application product owner
+  # I want license finder to generate an easy-to-understand text report
+  # So that I can quickly review my application dependencies and licenses
+
+  let(:user) { LicenseFinder::TestingDSL::User.new }
+
+  specify "shows dependency data in CSV form" do
+    user.create_empty_project
+    user.execute_command 'license_finder dependencies add info_gem BSD 1.1.1'
+
+    user.execute_command('license_finder report --format csv --columns approved name version licenses')
+    expect(user).to be_seeing "Not approved,info_gem,1.1.1,BSD"
+  end
+end