license_finder 0.8.0-java

data/features/step_definitions/steps.rb

@@ -0,0 +1,376 @@
+require 'fileutils'
+require 'pathname'
+require 'bundler'
+require 'capybara'
+
+Given /^I have a rails app(?:lication)? with license finder$/ do
+  @user = ::DSL::User.new
+  @user.create_rails_app
+end
+
+Given /^I have an app(?:lication)? with license finder$/ do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+end
+
+Given /^I have an app(?:lication)? with rake and license finder$/ do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+  @user.add_license_finder_to_rakefile
+end
+
+Given /^my app(?:lication)? does not have a "([^"]+)" directory$/ do |name|
+  path = @user.app_path(name)
+
+  FileUtils.rm_rf(path)
+  File.should_not be_exists(path)
+end
+
+Given /^my (?:rails )?app(?:lication)? depends on a gem "(.*?)" licensed with "(.*?)"$/ do |gem_name, license|
+  @user.add_dependency_to_app gem_name, :license => license
+end
+
+Given /^my (?:rails )?app(?:lication)? depends on a gem "(.*?)" licensed with "(.*?)" in the "(.*?)" bundler groups$/ do |gem_name, license, bundler_groups|
+  @user.add_dependency_to_app gem_name, :license => license, :bundler_groups => bundler_groups
+end
+
+Given /^I whitelist the "(.*?)" license$/ do |license|
+  @user.configure_license_finder_whitelist [license]
+end
+
+Given /^I whitelist the following licenses: "([^"]*)"$/ do |licenses|
+  @user.configure_license_finder_whitelist licenses.split(", ")
+end
+
+Given /^I have a legacy dependencies\.yml file with "(.*?)" approved with its "(.*?)" license$/ do |gem_name, license_name|
+  @user.modifying_dependencies_file do |f|
+    f.write <<-YAML
+    - name: #{gem_name}
+      version: 1.5.0
+      license: #{license_name}
+      approved: true
+      notes: ''
+      license_files:
+      - path: /some/path/to/files/that/are/rad
+    YAML
+  end
+end
+
+And /^I have a legacy dependencies\.yml file with readme_files entry for gem "(.*?)"$/  do |gem_name|
+  @user.modifying_dependencies_file do |f|
+    f.write <<-YAML
+    - name: #{gem_name}
+      version: 1.5.0
+      license: some_license
+      approved: true
+      notes: ''
+      license_files:
+      - path: /some/path/to/files/that/are/rad
+      readme_files:
+      - path: /some/path/to/files/that/are/rad/readme
+    YAML
+  end
+end
+
+Given /^I have a legacy dependencies\.yml file with a blank readme_files entry for gem "(.*?)"$/ do |gem_name|
+  @user.modifying_dependencies_file do |f|
+    f.write(<<-YAML)
+    - name: #{gem_name}
+      version: 1.5.0
+      license: some_license
+      approved: true
+      notes: ''
+      license_files:
+      - path: /some/path/to/files/that/are/rad
+      readme_files:
+    YAML
+  end
+end
+
+When /^I run "(.*?)"$/ do |command|
+  @output = @user.execute_command command
+end
+
+When /^I update the settings for "([^"]*)" with the following content:$/ do |gem, text|
+  @user.update_gem(gem, YAML.load(text))
+end
+
+When /^I add the following content to "([^"]*)":$/ do |filename, text|
+  @user.append_to_file(filename, @content = text)
+end
+
+When /^my app(?:lication)? depends on a gem "([^"]*)" with:$/ do |gem_name, gem_info|
+  info = gem_info.hashes.first
+  @user.add_dependency_to_app(gem_name,
+    :license        => info["license"],
+    :summary        => info["summary"],
+    :description    => info["description"],
+    :version        => info["version"],
+    :homepage       => info["homepage"],
+    :bundler_groups => info["bundler_groups"]
+  )
+end
+
+When /^the text "([^"]*)" should link to "([^"]*)"$/ do |text, link|
+  html = Capybara.string File.read(@user.dependencies_html_path)
+  html.all(:xpath, "//a[@href='#{link}']").first.text.should == text
+end
+
+When /^"([^"]*)" is an alternative name for the "MIT" license$/ do |alternative_name|
+  # this step is simply for readability
+end
+
+When /^I whitelist the "([^"]*)" bundler group$/ do |group|
+  @user.configure_license_finder_bundler_whitelist(group)
+end
+
+Then(/^I should see other_license_gem set to MIT license$/) do
+  @output.should =~ /other_license_gem.*MIT/
+end
+
+Then /^I should see a "([^"]+)" directory$/ do |name|
+  File.should be_exists(@user.app_path(name))
+end
+
+Then /^I should see "(.*?)" in its output$/ do |gem_name|
+  @output.should include gem_name
+end
+
+Then /^I should not see "(.*?)" in its output$/ do |gem_name|
+  @output.should_not include gem_name
+end
+
+Then /^I should see the file "([^"]*)" with the following content:$/ do |filename, text|
+  File.read(@user.app_path(filename)).should == text.gsub(/^\s+/, "")
+end
+
+Then /^I should see the file "([^"]*)" containing:$/ do |filename, text|
+  File.read(@user.app_path(filename)).should include(text.gsub(/^\s+/, ""))
+end
+
+Then /^I should see exactly one entry for "(.*?)" in "(.*?)"$/ do |gem_name, filename|
+  file_contents = File.read(@user.app_path(filename))
+  file_contents.scan(/#{gem_name}/).size.should == 1
+end
+
+Then /^I should not see an entry "(.*?)" for gem "(.*?)" in my dependencies\.yml$/ do |entry_key, gem_name|
+  settings = YAML.load(File.read(@user.dependencies_file_path))
+  gem_settings = settings.detect { |gem| gem['name'] == gem_name }
+  gem_settings.should_not have_key entry_key
+end
+
+Then /^it should exit with status code (\d)$/ do |status|
+  $?.exitstatus.should == status.to_i
+end
+
+Then /^I should see the "([^"]*)" in the html flagged as "([^"]*)"$/ do |gem_name, css_class|
+  html = File.read(@user.dependencies_html_path)
+  page = Capybara.string(html)
+  gpl_gem = page.find("##{gem_name}")
+  gpl_gem[:class].should == css_class
+end
+
+Then /^I should see (?:the )?"([^"]*)" in the html with the following details:$/ do |gem_name, table|
+  html = File.read(@user.dependencies_html_path)
+  page = Capybara.string(html)
+  section = page.find("##{gem_name}")
+
+  table.hashes.first.each do |property_name, property_value|
+    section.should have_content property_value
+  end
+end
+
+Then /^I should see "([^"]*)" in the html$/ do |text|
+  html = File.read(@user.dependencies_html_path)
+  page = Capybara.string(html)
+
+  page.should have_content text
+end
+
+module DSL
+  class User
+    def create_nonrails_app
+      reset_projects!
+
+      `cd #{projects_path} && bundle gem #{app_name}`
+
+      add_gem_dependency('rake')
+      add_gem_dependency('license_finder', :path => root_path)
+
+      bundle_app
+    end
+
+    def create_rails_app
+      reset_projects!
+
+      `bundle exec rails new #{app_path} --skip-bundle`
+
+      add_gem_dependency('license_finder', :path => root_path)
+
+      bundle_app
+    end
+
+    def add_license_finder_to_rakefile
+      add_to_rakefile <<-RUBY
+        require 'bundler/setup'
+        require 'license_finder'
+        LicenseFinder.load_rake_tasks
+      RUBY
+    end
+
+    def update_gem(name, attrs)
+      file_contents = YAML.load(File.read(dependencies_file_path))
+
+      index = file_contents.index { |gem| gem['name'] == name }
+      file_contents[index].merge!(attrs)
+
+      File.open(dependencies_file_path, "w") do |f|
+        f.puts file_contents.to_yaml
+      end
+    end
+
+    def append_to_file(filename, text)
+      File.open(File.join(app_path, filename), "a") do |f|
+        f.puts text
+      end
+    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]
+
+      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
+      end
+
+      gem_options = {}
+      gem_options[:path] = File.join(projects_path, gem_name)
+      gem_options[:groups] = bundler_groups unless bundler_groups.empty?
+
+      add_gem_dependency(gem_name, gem_options)
+
+      bundle_app
+    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|
+        f.write({'whitelist' => whitelisted_licenses}.to_yaml)
+      end
+    end
+
+    def configure_license_finder_bundler_whitelist(whitelisted_groups=[])
+      whitelisted_groups = Array whitelisted_groups
+      FileUtils.mkdir_p(config_path)
+      File.open(File.join(config_path, "license_finder.yml"), "w") do |f|
+        f.write({'ignore_groups' => whitelisted_groups}.to_yaml)
+      end
+    end
+
+    def execute_command(command)
+      Bundler.with_clean_env do
+        @output = `cd #{app_path} && bundle exec #{command}`
+      end
+
+      @output
+    end
+
+    def app_path(sub_directory = nil)
+      path = app_path = Pathname.new(File.join(projects_path, app_name)).cleanpath.to_s
+
+      if sub_directory
+        path = Pathname.new(File.join(app_path, sub_directory)).cleanpath.to_s
+
+        raise "#{name} is outside of the app" unless path =~ %r{^#{app_path}/}
+      end
+
+      path
+    end
+
+    def config_path
+      File.join(app_path, 'config')
+    end
+
+    def doc_path
+      File.join(app_path, 'doc')
+    end
+
+    def dependencies_file_path
+      File.join(doc_path, 'dependencies.yml')
+    end
+
+    def dependencies_html_path
+      File.join(doc_path, 'dependencies.html')
+    end
+
+    def add_gem_dependency(name, options = {})
+      line = "gem #{name.inspect}"
+      line << ", " + options.inspect unless options.empty?
+
+      add_to_gemfile(line)
+    end
+
+    def bundle_app
+      Bundler.with_clean_env do
+        `bundle install --gemfile=#{File.join(app_path, "Gemfile")} --path=#{bundle_path}`
+      end
+    end
+
+    def modifying_dependencies_file
+      FileUtils.mkdir_p(File.dirname(dependencies_file_path))
+      File.open(dependencies_file_path, 'w+') { |f| yield f }
+    end
+
+    private
+
+    def add_to_gemfile(line)
+      `echo #{line.inspect} >> #{File.join(app_path, "Gemfile")}`
+    end
+
+    def add_to_rakefile(line)
+      `echo #{line.inspect} >> #{File.join(app_path, "Rakefile")}`
+    end
+
+    def app_name
+      "my_app"
+    end
+
+    def sandbox_path
+      File.join(root_path, "tmp")
+    end
+
+    def projects_path
+      File.join(sandbox_path, "projects")
+    end
+
+    def bundle_path
+      File.join(sandbox_path, "bundle")
+    end
+
+    def reset_projects!
+      `rm -rf #{projects_path}`
+      `mkdir -p #{projects_path}`
+    end
+
+    def root_path
+      Pathname.new(File.join(File.dirname(__FILE__), "..", "..")).realpath.to_s
+    end
+  end
+end

data/features/text_report.feature

@@ -0,0 +1,27 @@
+Feature: Text Report
+  So that I can easily view a report outlining my application dependencies and licenses
+  As a non-technical application product owner
+  I want license finder to generate an easy-to-understand text report
+
+  Scenario: Viewing dependencies
+    Given I have an app with license finder
+    And my application depends on a gem "descriptive_gem" with:
+      | license | version |
+      | MIT     | 1.1.1   |
+    When I run "license_finder"
+    Then I should see the file "doc/dependencies.txt" containing:
+      """
+      descriptive_gem, 1.1.1, MIT
+      """
+
+  Scenario: Viewing dependencies after multiple runs
+    Given I have an app with license finder
+    And my application depends on a gem "descriptive_gem" with:
+      | license | version |
+      | MIT     | 1.1.1   |
+    When I run "license_finder"
+    And I run "license_finder"
+    Then I should see the file "doc/dependencies.txt" containing:
+      """
+      descriptive_gem, 1.1.1, MIT
+      """

data/features/whitelist.feature

@@ -0,0 +1,24 @@
+Feature: Whitelist licenses
+  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
+
+  Scenario: Auditing an application with whitelisted licenses
+    Given I have an app with license finder
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    When I run "license_finder"
+    Then I should see "mit_licensed_gem" in its output
+    When I whitelist the following licenses: "MIT, other"
+    And I run "license_finder"
+    Then I should see "All gems are approved for use" in its output
+    And it should exit with status code 0
+
+  Scenario: Whitelist with MIT License alternative name "Expat" should whitelist "MIT" licenses
+    Given I have an app with license finder
+    And "Expat" is an alternative name for the "MIT" license
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    When I run "license_finder"
+    Then I should see "mit_licensed_gem" in its output
+    When I whitelist the "Expat" license
+    And I run "license_finder"
+    Then I should not see "mit_licensed_gem" in its output

data/files/license_finder.yml

@@ -0,0 +1,8 @@
+---
+whitelist:
+#- MIT
+#- Apache 2.0
+ignore_groups:
+#- test
+#- development
+dependencies_file_dir: './doc/'

data/lib/data/licenses/Apache2.txt

@@ -0,0 +1,172 @@
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS