gitlab-license_finder 6.14.2.1

data/ci/tasks/run-tests.yml

@@ -0,0 +1,10 @@
+platform: linux
+
+inputs:
+- name: LicenseFinder
+
+run:
+  path: ./LicenseFinder/ci/scripts/run-tests.sh
+
+params:
+  RUBY_VERSION_UNDER_TEST:

data/ci/tasks/update-changelog.yml

@@ -0,0 +1,18 @@
+---
+image_resource:
+  type: registry-image
+  source:
+    repository: brenix/alpine-bash-git-ssh
+    tag: latest
+    username: ((LicenseFinderDocker.username))
+    password: ((LicenseFinderDocker.password))
+platform: linux
+inputs:
+- name: lf-git
+- name: lf-release
+- name: semver-version
+outputs:
+- name: lf-git-changed
+- name: version
+run:
+  path: lf-git/ci/scripts/updateChangelog.sh

data/dlf

@@ -0,0 +1,12 @@
+#!/bin/bash
+if `which docker > /dev/null`; then
+	if [ $# -eq 0 ]; then
+  		docker run -v $PWD:/scan -it licensefinder/license_finder
+	else
+  		docker run -v $PWD:/scan -it licensefinder/license_finder /bin/bash -lc "cd /scan && `echo $@`"
+	fi
+else
+  echo "You do not have docker installed. Please install it:"
+  echo "    https://docs.docker.com/engine/installation/"
+  exit 1
+fi

data/examples/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gem 'license_finder', path: '..'

data/examples/custom_erb_template.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+# This is an example of how to programatically generate a report using a custom
+# ERB template. Run with
+# > bundle install
+# > ./custom_erb_template.rb
+
+require 'license_finder'
+
+# See lib/license_finder/core.rb for more configuration options.
+# A quiet logger is required when running reports...
+lf = LicenseFinder::Core.new(LicenseFinder::Configuration.with_optional_saved_config(logger: :quiet))
+
+# Find many more examples of complex ERB templates in
+# lib/license_finder/reports/templates/
+template = Pathname.new('./sample_template.erb')
+print LicenseFinder::ErbReport
+  .new(lf.acknowledged, project_name: lf.project_name)
+  .to_s(template)

data/examples/extract_license_data.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+# This is an example of how to programatically extract the information that
+# LicenseFinder has about packages and their licenses.
+# > bundle install
+# > ./extract_license_data.rb
+
+require 'license_finder'
+
+# See lib/license_finder/core.rb for more configuration options.
+# A quiet logger is required when running reports...
+lf = LicenseFinder::Core.new(LicenseFinder::Configuration.with_optional_saved_config(logger: :quiet))
+
+# Groups of packages
+lf.acknowledged # All (non-ignored) packages license_finder is tracking
+lf.unapproved # The packages which have not been approved or permitted
+lf.restricted # The packages which have been restricted
+
+# Package details
+lf.acknowledged.each do |package|
+  # Approvals
+  package.approved? # Whether the package has been approved manually or permitted
+  package.approved_manually?
+  package.permitted?
+  package.restricted?
+
+  # Licensing
+  # The set of licenses, each of which has a name and url, which
+  # license_finder will report for this package.
+  package.licenses
+  # Additional information about how these licenses were chosen
+  # (from decision, from spec, from files, or none-found).  See
+  # LicenseFinder::Licensing and LicenseFinder::Activation
+  package.activations
+  # The files that look like licenses, found in the package's
+  # directory.  Caveat: if a package's licenses were specified by a decision or
+  # by the package's spec, the license_files will be ignored.  That means,
+  # package.licenses may report different licenses than those found in
+  # license_files.
+  package.license_files
+  package.license_files.each do |file|
+    # The license found in this file.
+    file.license
+    # The text of the file.  Sometimes this will be an entire README file,
+    # because license_finder has found the phrase "is released under the
+    # MIT license" in it.
+    file.text
+  end
+  package.licensing.activations_from_decisions # If license_finder only knew about decisions, what licenses would it report?
+  package.licensing.activations_from_spec      # If license_finder only knew about package specs, what licenses would it report?
+  package.licensing.activations_from_files     # If license_finder only knew about package files, what licenses would it report?
+  package.licensing.activations_from_files.each do |activation|
+    # Each activation groups together all files that point to the same license.
+    # Each file contains its #license and #text.
+    activation.license
+    activation.files
+  end
+end

data/examples/sample_template.erb

@@ -0,0 +1,7 @@
+Licenses
+
+<%= dependencies.size %> total
+
+<% grouped_dependencies.each do |license_name, group| -%>
+* <%= group.size %> <%= license_name %>
+<% end %>

data/lib/license_finder/cli/approvals.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class Approvals < Base
+      extend Subcommand
+      include MakesDecisions
+
+      auditable
+      approvable
+      desc 'add DEPENDENCY...', 'Approve one or more dependencies by name'
+      def add(*names)
+        assert_some names
+        modifying { names.each { |name| decisions.approve(name, txn) } }
+
+        say "The #{names.join(', ')} dependency has been approved!", :green
+      end
+
+      auditable
+      desc 'remove DEPENDENCY', 'Unapprove a dependency'
+      def remove(dep)
+        modifying { decisions.unapprove(dep, txn) }
+
+        say "The dependency #{dep} no longer has a manual approval"
+      end
+    end
+  end
+end

data/lib/license_finder/cli/base.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module LicenseFinder
+  module CLI
+    class Base < Thor
+      class_option :project_path,
+                   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/prepare_$PACKAGE_MANAGER.log'
+      class_option :enabled_package_managers,
+                   desc: 'List of package managers to be enabled. Defaults to all supported package managers.',
+                   type: :array,
+                   enum: LicenseFinder::Scanner.supported_package_manager_ids
+
+      no_commands do
+        def decisions
+          @decisions ||= DecisionsFactory.decisions(config.decisions_file_path)
+        end
+
+        def config
+          @config ||= Configuration.with_optional_saved_config(license_finder_config)
+        end
+      end
+
+      private
+
+      def fail(message)
+        say(message) && exit(1)
+      end
+
+      def license_finder_config
+        extract_options(
+          :project_path,
+          :decisions_file,
+          :enabled_package_managers,
+          :go_full_version,
+          :gradle_command,
+          :gradle_include_groups,
+          :maven_include_groups,
+          :maven_options,
+          :npm_options,
+          :pip_requirements_path,
+          :python_version,
+          :rebar_command,
+          :rebar_deps_dir,
+          :elixir_command,
+          :mix_command,
+          :mix_deps_dir,
+          :write_headers,
+          :save,
+          :prepare,
+          :prepare_no_fail,
+          :log_directory,
+          :format,
+          :columns,
+          :aggregate_paths,
+          :recursive,
+          :sbt_include_groups,
+          :conda_bash_setup_script,
+          :composer_check_require_only
+        ).merge(
+          logger: logger_mode
+        )
+      end
+
+      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]
+          quiet
+        elsif mode[debug]
+          debug
+        else
+          info
+        end
+      end
+
+      def say_each(coll)
+        if coll.any?
+          coll.each do |item|
+            say(block_given? ? yield(item) : item)
+          end
+        else
+          say '(none)'
+        end
+      end
+
+      def assert_some(things)
+        raise ArgumentError, 'wrong number of arguments (0 for 1+)', caller unless things.any?
+      end
+
+      def extract_options(*keys)
+        result = {}
+        keys.each do |key|
+          result[key.to_sym] = options[key.to_s] if options.key? key.to_s
+        end
+        result
+      end
+    end
+  end
+end

data/lib/license_finder/cli/dependencies.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class Dependencies < Base
+      extend Subcommand
+      include MakesDecisions
+
+      method_option :approve, type: :boolean, desc: 'Approve the added dependency'
+      method_option :homepage, type: :string, desc: 'Source of the added dependency'
+
+      auditable
+      desc 'add DEPENDENCY LICENSE VERSION [--homepage=HOMEPAGE] [--approve]', 'Add a dependency that is not managed by a package manager, optionally approving it at the same time'
+      def add(name, license, version)
+        modifying do
+          decisions
+            .add_package(name, version, txn)
+            .license(name, license, txn)
+          decisions.homepage(name, options[:homepage], txn) if options[:homepage]
+          decisions.approve(name, txn) if options[:approve]
+        end
+        if options[:approve]
+          say "The #{name} dependency has been added and approved!", :green
+        else
+          say "The #{name} dependency has been added!", :green
+        end
+      end
+
+      auditable
+      desc 'remove DEPENDENCY', 'Remove a dependency that is not managed by a package manager'
+      def remove(name)
+        modifying { decisions.remove_package(name, txn) }
+
+        say "The #{name} dependency has been removed.", :green
+      end
+
+      desc 'list', 'List manually added dependencies'
+      def list
+        say 'Manually Added Dependencies:', :blue
+        say_each(decisions.packages, &:name)
+      end
+    end
+  end
+end

data/lib/license_finder/cli/ignored_dependencies.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class IgnoredDependencies < Base
+      extend Subcommand
+      include MakesDecisions
+
+      desc 'list', 'List all the ignored dependencies'
+      def list
+        say 'Ignored Dependencies:', :blue
+        say_each(decisions.ignored)
+      end
+
+      auditable
+      desc 'add DEPENDENCY', 'Add a dependency to be ignored'
+      def add(dep)
+        modifying { decisions.ignore(dep, txn) }
+
+        say "Added #{dep} to the ignored dependencies"
+      end
+
+      auditable
+      desc 'remove DEPENDENCY', 'Remove a dependency from the ignored dependencies'
+      def remove(dep)
+        modifying { decisions.heed(dep, txn) }
+
+        say "Removed #{dep} from the ignored dependencies"
+      end
+    end
+  end
+end

data/lib/license_finder/cli/ignored_groups.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class IgnoredGroups < Base
+      extend Subcommand
+      include MakesDecisions
+
+      desc 'list', 'List all the ignored groups'
+      def list
+        say 'Ignored Groups:', :blue
+        say_each(decisions.ignored_groups)
+      end
+
+      auditable
+      desc 'add GROUP', 'Add a group to be ignored'
+      def add(group)
+        modifying { decisions.ignore_group(group, txn) }
+
+        say "Added #{group} to the ignored groups"
+      end
+
+      auditable
+      desc 'remove GROUP', 'Remove a group from the ignored groups'
+      def remove(group)
+        modifying { decisions.heed_group(group, txn) }
+
+        say "Removed #{group} from the ignored groups"
+      end
+    end
+  end
+end

data/lib/license_finder/cli/inherited_decisions.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class InheritedDecisions < Base
+      extend Subcommand
+      include MakesDecisions
+
+      desc 'list', 'List all the inherited decision files'
+      def list
+        say 'Inherited Decision Files:', :blue
+        say_each(decisions.inherited_decisions)
+      end
+
+      auditable
+      desc 'add DECISION_FILE...', 'Add one or more decision files to the inherited decisions'
+      def add(*decision_files)
+        assert_some decision_files
+        modifying { decision_files.each { |filepath| decisions.inherit_from(filepath) } }
+        say "Added #{decision_files.join(', ')} to the inherited decisions"
+      end
+
+      auditable
+      desc 'add_with_auth URL AUTH_TYPE TOKEN_OR_ENV', 'Add a remote decision file that needs authentication'
+      def add_with_auth(*params)
+        url, auth_type, token_or_env = params
+        auth_info = { 'url' => url, 'authorization' => "#{auth_type} #{token_or_env}" }
+        modifying { decisions.add_decision [:inherit_from, auth_info] }
+        say "Added #{url} to the inherited decisions"
+      end
+
+      auditable
+      desc 'remove DECISION_FILE...', 'Remove one or more decision files from the inherited decisions'
+      def remove(*decision_files)
+        assert_some decision_files
+        modifying { decision_files.each { |filepath| decisions.remove_inheritance(filepath) } }
+        say "Removed #{decision_files.join(', ')} from the inherited decisions"
+      end
+
+      auditable
+      desc 'remove_with_auth URL AUTH_TYPE TOKEN_OR_ENV', 'Add a remote decision file that needs authentication'
+      def remove_with_auth(*params)
+        url, auth_type, token_or_env = params
+        auth_info = { 'url' => url, 'authorization' => "#{auth_type} #{token_or_env}" }
+        modifying { decisions.remove_inheritance(auth_info) }
+        say "Removed #{url} from the inherited decisions"
+      end
+    end
+  end
+end

data/lib/license_finder/cli/licenses.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module LicenseFinder
+  module CLI
+    class Licenses < Base
+      extend Subcommand
+      include MakesDecisions
+
+      auditable
+      desc 'add DEPENDENCY LICENSE', "Set a dependency's licenses, overwriting any license_finder has found"
+      def add(name, license)
+        modifying { decisions.license(name, license, txn) }
+
+        say "The #{name} dependency has been marked as using #{license} license!", :green
+      end
+
+      auditable
+      desc 'remove DEPENDENCY LICENSE', 'Remove a manually set license'
+      def remove(dep, lic)
+        modifying { decisions.unlicense(dep, lic, txn) }
+
+        say "The dependency #{dep} no longer has a manual license"
+      end
+    end
+  end
+end