license_finder 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7666cca63edcbd5d26d92de0d0079eb6baba6f04
-  data.tar.gz: bd234f6e53146db0c10bb5aedec7bf2ab9666af0
+  metadata.gz: fc4eb2dc999e63e0e940edc1adaba70c722f53b8
+  data.tar.gz: e2439059250e4ec5e0db823bd911f5ddb360a772
 SHA512:
-  metadata.gz: 6632cd374b76addc79e2c094aaf2210ec8185319633ca15594eb5217cc29eb954b66e5a21ea081c28a171a6df3aea48f12d58f8a2759f4ac5c87e987121f332e
-  data.tar.gz: ff1d7062e96965b57f17260398faa2baa0fd4caffccec01b0d483ece2690e963c75779b3b6561b7b216ca9d4be42a51f1f830b2cfef57e6ebd7a091bd58c2895
+  metadata.gz: b6b05a9967e640c0c56423d062a3a4ae279217a51758be4f88ac4feae8d271222add27f586664bf79c8ae621cfda9495e40df7a500fa50650aa749bb0f8a58b0
+  data.tar.gz: 0f6365ebe0ad2fc32ead860a0b1a55dc29bf138f4c45e3d412e281f00ff26fa7cbbf154bd9c4ce1fcf2336682b29c25a6ae538d911e0f8281c94249cc9d08c0b

data/.rubocop.yml

@@ -1,6 +1,8 @@
 #Layout Cops
 IndentHeredoc:
   Enabled: false
+EmptyLinesAroundArguments:
+  Enabled: false
 
 #Linting Cops
 AmbiguousRegexpLiteral:
@@ -8,7 +10,7 @@ AmbiguousRegexpLiteral:
 
 # Metrics Cops
 AbcSize:
-  Max: 30
+  Max: 35
 BlockLength:
   Enabled: false # TODO: enable and refactor long methods
 #  ExcludedMethods: ['describe', 'context', 'it', 'shared_examples']  # uncomment once enabled
@@ -43,7 +45,7 @@ MethodMissing:
   Enabled: false
 ModuleFunction:
   Enabled: false
-
+  EnforcedStyle: extend_self
 AllCops:
   Include:
     - 'bin/license_finder'

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [4.0.2] / 2017-11-16
+
+### Fixed
+
+* Fixed --quiet not being available on the report task
+* Fixed --recursive not being available on the action_items task
+
+# [4.0.1] / 2017-11-14
+
+### Fixed
+
+* Add missing toml dependency to gemspec
+
 # [4.0.0] / 2017-11-10
 
 ### Changed
@@ -497,7 +510,9 @@ Bugfixes:
   * Fix blow up if there's not `ignore_groups` setting in the config file.
 
 
-[Unreleased]: https://github.com/pivotal/LicenseFinder/compare/v3.0.4...HEAD
+[Unreleased]: https://github.com/pivotal/LicenseFinder/compare/v4.0.2...HEAD
+[4.0.2]: https://github.com/pivotal/LicenseFinder/compare/v4.0.1...v4.0.2
+[4.0.1]: https://github.com/pivotal/LicenseFinder/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/pivotal/LicenseFinder/compare/v3.1.0...v4.0.0
 [3.1.0]: https://github.com/pivotal/LicenseFinder/compare/v3.0.4...v3.1.0
 [3.0.4]: https://github.com/pivotal/LicenseFinder/compare/v3.0.2...v3.0.4

data/CONTRIBUTING.md

@@ -10,23 +10,41 @@
 
 ## Running Tests
 
-You can use the [LicenseFinder docker image](https://hub.docker.com/r/licensefinder/license_finder/) to run the tests.
+You can use the [LicenseFinder docker image](https://hub.docker.com/r/licensefinder/license_finder/) to run the tests by using the `dlf` script.
+There are 2 sets of tests to run in order to confirm that License Finder is working as intended:
 
 ```
-$ docker run -it licensefinder/license_finder /bin/bash --login
+./dlf rake spec
+./dlf bundle exec rake features
+```
+
+The `spec` task runs all the unit test and the `features` task will run all the feature test.
+Note that the feature test needs to be wrapped in `bundle exec`, or else it
+will use the gem version installed inside the docker image.
+
+## Useful Tips
 
-# inside the container...
+To build the docker image simply call `docker build .` or explicitly pass the `Dockerfile`. Prebuilt versions of the 
+dockerfile can also be found on [Dockerhub](https://hub.docker.com/r/licensefinder/license_finder/tags/).  
 
-$ cd /LicenseFinder
-$ rake
+To launch the docker image and interact with it via bash:
 ```
+docker run -v $PWD:/scan -it licensefinder/license_finder /bin/bash -l
+
+```
+`-v $PWD:/scan` will mount the current working directory to the /scan path.
 
 ## Adding Package Managers
 
 There are a few steps to adding a new package manager.
+The main things which need to be implemented are mentioned in [Package Manager](https://github.com/pivotal/LicenseFinder/blob/master/lib/license_finder/package_manager.rb).
+
 [Here](https://github.com/pivotal/LicenseFinder/compare/v2.0.0...v2.0.1) is how
 support was added for `rebar`, an `erlang` package manager.
 
+There are feature tests and unit tests for each currently supported package manager.
+* [Feature test example](https://github.com/pivotal/LicenseFinder/blob/master/features/features/package_managers/gvt_spec.rb)
+* [Unit test example](https://github.com/pivotal/LicenseFinder/blob/master/spec/lib/license_finder/package_managers/gvt_spec.rb)
 
 ## Adding Licenses
 

data/Gemfile

@@ -1,3 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-gem 'toml', '0.1.2'

data/README.md

@@ -143,6 +143,11 @@ You can better understand the way this script works by looking at its source, bu
 reference it will mount your current directory at the path `/scan` and run any commands
 passed to it from that directory.
 
+Note that the docker image will run the gem which is installed within it. 
+So the docker image tagged `4.0.2` will run *License Finder Version 4.0.2*
+
+See the [contibuting guide](https://github.com/pivotal/LicenseFinder/blob/master/CONTRIBUTING.md) for information on development. 
+
 ### Activation
 
 `license_finder` will find and include packages for all supported
@@ -394,7 +399,7 @@ downloadLicenses {
 }
 ```
 
-### Conan rojects
+### Conan Projects
 
 `license_finder` supports Conan. You need to have the following lines in your conanfile.txt for `license_finder` to retrieve dependencies' licenses.
 Ensure that `conan install` does not generate an error. 

data/Rakefile

@@ -35,8 +35,8 @@ desc 'Check for non-Ruby development dependencies.'
 task :check_dependencies do
   require './lib/license_finder'
   satisfied = true
-  LicenseFinder::PackageManager.package_managers.each do |package_manager|
-    satisfied = false unless package_manager.installed?(LicenseFinder::Logger.new(debug: true))
+  LicenseFinder::Scanner::PACKAGE_MANAGERS.each do |package_manager|
+    satisfied = false unless package_manager.installed?(LicenseFinder::Logger.new(LicenseFinder::Logger::MODE_INFO))
   end
   STDOUT.flush
   exit 1 unless satisfied

data/ci/pipelines/pipeline.yml.erb

@@ -25,7 +25,7 @@ resources:
   source:
     repo: pivotal/LicenseFinder
     base: master
-    access_token: ((GithubApiTokenLicenseFinder))
+    access_token: ((GithubApiPullRequestToken))
 
 <% if setup_slack %>
 - name: slack-alert

data/ci/pipelines/release.yml

@@ -6,14 +6,6 @@ resources:
     private_key: ((CfOslBotPrivateKey))
     branch: master
 
-- name: lf-dockerfile
-  type: git
-  source:
-    uri: git@github.com:pivotal/LicenseFinder.git
-    private_key: ((CfOslBotPrivateKey))
-    branch: master
-    paths: ["Dockerfile"]
-
 - name: lf-image
   type: docker-image
   source:
@@ -27,16 +19,9 @@ resources:
   source:
     owner: pivotal
     repository: LicenseFinder
-    access_token: ((GithubApiTokenProduction))
+    access_token: ((GithubApiRootToken))
 
 jobs:
-- name: docker
-  plan:
-  - get: lf-dockerfile
-    trigger: true
-  - put: lf-image
-    params:
-     build: lf-dockerfile
 
 - name: release
   plan:
@@ -44,9 +29,18 @@ jobs:
   - get: lf-image
     params:
       save: true
-  - task: get-version-and-tag
+  - get: lf-release
+  - task: update-changelog
     image: lf-image
-    file: lf-git/ci/tasks/get-version-and-tag.yml
+    params:
+      GIT_USERNAME: ((GithubApiUser))
+      GIT_EMAIL: ((GithubApiEmail))
+    file: lf-git/ci/tasks/update-changelog.yml
+  - put: lf-image
+    params:
+      build: lf-git
+      tag: version/version.txt
+      tag_as_latest: true
   - task: build-and-push-gem
     image: lf-image
     params:
@@ -54,13 +48,10 @@ jobs:
     file: lf-git/ci/tasks/build-and-push-gem.yml
   - put: lf-git
     params:
-      repository: lf-git
+      repository: lf-git-changed
       tag: version/tag.txt
-  - put: lf-image
-    params:
-      load: lf-image
-      tag: version/version.txt
   - put: lf-release
     params:
       name: version/tag.txt
       tag: version/tag.txt
+      body: version/changelog.txt

data/ci/scripts/pushscript.sh

@@ -11,5 +11,4 @@ if [ -z "$(gem fetch license_finder -v $build_version 2>&1 | grep ERROR)" ]; the
   exit 0
 fi
 
-rake build
-gem push ${built_gem}
+rake release

data/ci/scripts/run-rubocop.sh

@@ -1,7 +1,7 @@
 #!/bin/bash -e
 
 cd LicenseFinder
-gem install rubocop
+gem install rubocop --version 0.51
 
 
 echo "Running Rubocop ..."

data/ci/scripts/updateChangelog.sh

@@ -0,0 +1,77 @@
+#!/bin/bash --login
+
+set -e
+
+git clone lf-git lf-git-changed
+
+CHANGELOG_FILE="CHANGELOG.md"
+COMMIT_URL="https://github.com/pivotal/LicenseFinder/commit/"
+
+TAGS=( "Added" "ADDED" "Fixed" "FIXED" "Changed" "CHANGED" "Deprecated" "DEPRECATED" "Removed" "REMOVED" "Security" "SECURITY" )
+CONTRIBUTORS=( "Shane Lattanzio" "Daniil Kouznetsov" "Andy Shen" "Li Tai" "Ryan Collins" "Vikram Yadav" )
+
+OLD="v$(cat ./lf-release/version)"
+VERSION="$(ruby -r ./lf-git-changed/lib/license_finder/version.rb -e "puts LicenseFinder::VERSION")"
+VERSION_TAG="v$VERSION"
+
+# Add version title information
+LOG=$(echo "# [$VERSION] / $(date +%Y-%m-%d)\n")
+
+cd lf-git-changed
+
+for ((i = 0; i < ${#TAGS[@]}; i++)); do
+    if [[ $i -gt 0 ]]; then
+        TAG_COMPARE=$(echo "${TAGS[$i]}" | grep -qi "${TAGS[$i - 1]}" && echo same || echo different)
+        HEADER_EXISTS=$(echo "$LOG" | grep -qi "${TAGS[$i - 1]}" && echo exists || echo dne)
+    fi
+
+    GIT_LOG=$'\n'$(git log "$OLD"...HEAD --pretty=format:"%H%n%s - [%h]($COMMIT_URL%H) - %an%n%n"| grep -E "\[${TAGS[$i]}\] .*" | sort | sed -e "s/\[${TAGS[$i]}\]/\*/g")
+
+    # Only add section information if it has content
+    if [[ $i -ne $[${#TAGS[@]}-1] && $GIT_LOG =~ "." && $i -gt 0 && "$TAG_COMPARE" == "same" && "$HEADER_EXISTS" == "exists"  ]]; then
+        LOG="$LOG""$GIT_LOG\n"
+    elif [[ $GIT_LOG =~ "." ]]; then
+        if [[ $i -gt 0 && "$TAG_COMPARE" == "same" && "$HEADER_EXISTS" == "dne" ]]; then
+            LOG="$LOG"$'\n'$(echo "### ${TAGS[$i - 1]}")"$GIT_LOG\n"
+        else
+            LOG="$LOG"$'\n'$(echo "### ${TAGS[$i]}")"$GIT_LOG\n"
+        fi
+    fi
+done
+
+# Strip Pivotal contributors
+for ((i = 0; i < ${#CONTRIBUTORS[@]}; i++)); do
+    LOG=$(echo "$LOG" | sed -e "s/-* ${CONTRIBUTORS[$i]}//g")
+done
+
+# Prepend new version information at the top of the file
+echo -e "$LOG\n$(cat $CHANGELOG_FILE)" > $CHANGELOG_FILE
+
+# Append version hyperlink to the end of the file
+echo -e "[$VERSION]: https://github.com/pivotal/LicenseFinder/compare/$OLD...$VERSION_TAG" >> $CHANGELOG_FILE
+
+git config --global user.email $GIT_EMAIL
+git config --global user.name $GIT_USERNAME
+
+git add $CHANGELOG_FILE
+git commit -m "Update changelog for version: $VERSION"
+
+echo "New version: $VERSION"
+echo "Current version: $OLD"
+
+if [ "$VERSION" == "$OLD" ]; then
+    echo "Error: Version in version.rb is identical to latest release on github"
+    exit 1
+fi
+
+body=$(cat "$CHANGELOG_FILE" | sed -n "/# \[$VERSION\]/,/# \[[\d\.]*/p" | sed '$d' | tail -n +2)
+
+echo "$VERSION_TAG" > ../version/tag.txt
+echo "$VERSION" > ../version/version.txt
+echo "$body" > ../version/changelog.txt
+
+echo "Tag: $VERSION_TAG"
+echo "Version: $VERSION"
+echo "Body: $body"
+
+exit 0

data/ci/tasks/build.yml

@@ -4,7 +4,7 @@ image_resource:
   type: docker-image
   source:
     repository: concourse/docker-image-resource
-    tag: latest
+    tag: pr-141
 
 inputs:
 - name: LicenseFinder

data/ci/tasks/update-changelog.yml

@@ -0,0 +1,15 @@
+---
+image_resource:
+  type: docker-image
+  source:
+    repository: licensefinder/license_finder
+    tag: latest
+platform: linux
+inputs:
+- name: lf-git
+- name: lf-release
+outputs:
+- name: version
+- name: lf-git-changed
+run:
+  path: lf-git/ci/scripts/updateChangelog.sh

data/lib/license_finder/cli/base.rb

@@ -7,21 +7,21 @@ module LicenseFinder
                    desc: 'Path to the project. Defaults to current working directory.'
       class_option :decisions_file,
                    desc: 'Where decisions are saved. Defaults to doc/dependency_decisions.yml.'
+      class_option :log_directory,
+                   desc: 'Where logs are saved. Defaults to ./lf_logs/$PROJECT/$PACKAGE_MANAGER.log'
 
       no_commands do
         def decisions
-          license_finder.decisions
+          @decisions ||= DecisionsFactory.decisions(config.decisions_file_path)
+        end
+
+        def config
+          @config ||= Configuration.with_optional_saved_config(license_finder_config)
         end
       end
 
       private
 
-      def license_finder
-        @lf ||= LicenseFinder::Core.new(license_finder_config)
-        fail "Project path '#{@lf.config.project_path}' does not exist!" unless @lf.config.valid_project_path?
-        @lf
-      end
-
       def fail(message)
         say(message) && exit(1)
       end
@@ -41,23 +41,29 @@ module LicenseFinder
           :mix_command,
           :mix_deps_dir,
           :save,
-          :prepare
+          :prepare,
+          :prepare_no_fail,
+          :log_directory,
+          :format,
+          :columns,
+          :aggregate_paths,
+          :recursive
         ).merge(
-          logger: logger_config
+          logger: logger_mode
         )
       end
 
-      def logger_config
+      def logger_mode
         quiet = LicenseFinder::Logger::MODE_QUIET
         debug = LicenseFinder::Logger::MODE_DEBUG
         info = LicenseFinder::Logger::MODE_INFO
         mode = extract_options(quiet, debug)
         if mode[quiet]
-          { mode: quiet }
+          quiet
         elsif mode[debug]
-          { mode: debug }
+          debug
         else
-          { mode: info }
+          info
         end
       end
 

data/lib/license_finder/cli/main.rb

@@ -5,7 +5,6 @@ require 'license_finder/package_delta'
 require 'license_finder/license_aggregator'
 require 'license_finder/project_finder'
 require 'license_finder/logger'
-
 module LicenseFinder
   module CLI
     class Main < Base
@@ -18,9 +17,6 @@ module LicenseFinder
         'csv' => CsvReport
       }.freeze
 
-      class_option :format, desc: 'The desired output format.', default: 'text', enum: FORMATS.keys
-      class_option :columns, type: :array, desc: "For text or CSV reports, which columns to print. Pick from: #{CsvReport::AVAILABLE_COLUMNS}", default: %w[name version licenses]
-      class_option :save, desc: "Save report to a file. Default: 'license_report.csv' in project root.", lazy_default: 'license_report'
       class_option :go_full_version, desc: 'Whether dependency version should include full version. Only meaningful if used with a Go project. Defaults to false.'
       class_option :gradle_include_groups, desc: 'Whether dependency name should include group id. Only meaningful if used with a Java/gradle project. Defaults to false.'
       class_option :gradle_command,
@@ -35,6 +31,13 @@ module LicenseFinder
       class_option :mix_deps_dir, desc: "Path to Mix dependencies directory. Only meaningful if used with a Mix project (i.e., Elixir or Erlang). Defaults to 'deps'."
 
       # Method options which are shared between report and action_item
+      def self.format_option
+        method_option :format,
+                      desc: 'Emit detailed info about what LicenseFinder is doing',
+                      default: 'text',
+                      enum: FORMATS.keys
+      end
+
       def self.shared_options
         method_option :debug,
                       aliases: '-d',
@@ -48,19 +51,39 @@ module LicenseFinder
                       default: false,
                       required: false
 
-        method_option :recursive, aliases: '-r', type: :boolean, default: false,
-                                  desc: 'Recursively runs License Finder on all sub-projects'
+        method_option :prepare_no_fail,
+                      type: :boolean,
+                      desc: 'Prepares the project first for license_finder but carries on despite any potential failures',
+                      default: false,
+                      required: false
 
-        method_option :aggregate_paths, aliases: '-a', type: :array,
-                                        desc: "Generate a single report for multiple projects. Ex: --aggregate_paths='path/to/project1' 'path/to/project2'"
+        method_option :recursive,
+                      aliases: '-r',
+                      type: :boolean,
+                      default: false,
+                      desc: 'Recursively runs License Finder on all sub-projects'
+
+        method_option :aggregate_paths,
+                      aliases: '-a',
+                      type: :array,
+                      desc: "Generate a single report for multiple projects. Ex: --aggregate_paths='path/to/project1' 'path/to/project2'"
 
-        method_option :quiet, aliases: '-q', type: :boolean, desc: 'Silences progress report', required: false
+        method_option :quiet,
+                      aliases: '-q',
+                      type: :boolean,
+                      desc: 'Silences progress report',
+                      required: false
+
+        method_option :columns,
+                      desc: "For text or CSV reports, which columns to print. Pick from: #{CsvReport::AVAILABLE_COLUMNS}",
+                      type: :array
       end
 
       desc 'action_items', 'List unapproved dependencies (the default action for `license_finder`)'
       shared_options
+      format_option
       def action_items
-        finder = LicenseAggregator.new(license_finder_config, aggregate_paths)
+        finder = LicenseAggregator.new(config, aggregate_paths)
         any_packages = finder.any_packages?
         unapproved = finder.unapproved
         blacklisted = finder.blacklisted
@@ -95,20 +118,13 @@ module LicenseFinder
 
       desc 'report', "Print a report of the project's dependencies to stdout"
       shared_options
+      format_option
+      method_option :save, desc: "Save report to a file. Default: 'license_report.csv' in project root.", lazy_default: 'license_report'
 
       def report
-        logger_config[:mode] = Logger::MODE_QUIET
-        aggregate_paths = options[:aggregate_paths]
-        aggregate_paths = ProjectFinder.new(license_finder.config.project_path).find_projects if options[:recursive]
-
-        if aggregate_paths && !aggregate_paths.empty?
-          finder = LicenseAggregator.new(license_finder_config, aggregate_paths)
-          report = MergedReport.new(finder.dependencies, options)
-        else
-          run_prepare_phase if prepare?
-          report = report_of(license_finder.acknowledged)
-        end
-        save? ? save_report(report, options[:save]) : say(report)
+        finder = LicenseAggregator.new(config, aggregate_paths)
+        report = report_of(finder.dependencies)
+        save? ? save_report(report, config.save_file) : say(report)
       end
 
       desc 'version', 'Print the version of LicenseFinder'
@@ -117,11 +133,13 @@ module LicenseFinder
       end
 
       desc 'diff OLDFILE NEWFILE', 'Command to view the differences between two generated reports (csv).'
+      format_option
+      method_option :save, desc: "Save report to a file. Default: 'license_report.csv' in project root.", lazy_default: 'license_report'
       def diff(file1, file2)
         f1 = IO.read(file1)
         f2 = IO.read(file2)
         report = DiffReport.new(Diff.compare(f1, f2))
-        save? ? save_report(report, options[:save]) : say(report)
+        save? ? save_report(report, config.save_file) : say(report)
       end
 
       subcommand 'dependencies', Dependencies, 'Add or remove dependencies that your package managers are not aware of'
@@ -135,11 +153,17 @@ module LicenseFinder
 
       private
 
+      def check_valid_project_path
+        raise "Project path '#{config.project_path}' does not exist!" unless config.valid_project_path?
+      end
+
       def aggregate_paths
-        aggregate_paths = options[:aggregate_paths]
-        aggregate_paths = ProjectFinder.new(license_finder.config.project_path).find_projects if options[:recursive]
+        check_valid_project_path
+        aggregate_paths = config.aggregate_paths
+        project_path = config.project_path || Pathname.pwd
+        aggregate_paths = ProjectFinder.new(project_path).find_projects if config.recursive
         return aggregate_paths unless aggregate_paths.nil? || aggregate_paths.empty?
-        [license_finder_config[:project_path]] unless license_finder_config[:project_path].nil?
+        [config.project_path] unless config.project_path.nil?
       end
 
       def save_report(content, file_name)
@@ -149,20 +173,13 @@ module LicenseFinder
       end
 
       def report_of(content)
-        report = FORMATS[options[:format]]
-        report.of(content, columns: options[:columns], project_name: license_finder.project_name)
+        report = FORMATS[config.format] || FORMATS['text']
+        report = MergedReport if report == CsvReport && config.aggregate_paths
+        report.of(content, columns: config.columns, project_name: decisions.project_name || config.project_path.basename.to_s)
       end
 
       def save?
-        !!options[:save]
-      end
-
-      def prepare?
-        options[:prepare]
-      end
-
-      def run_prepare_phase
-        license_finder.prepare_projects
+        !!config.save_file
       end
     end
   end