license_finder 3.0.4 → 3.1.1

data/ci/pipelines/release.yml

@@ -6,6 +6,14 @@ 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:
@@ -24,10 +32,11 @@ resources:
 jobs:
 - name: docker
   plan:
-  - get: lf-git
+  - get: lf-dockerfile
+    trigger: true
   - put: lf-image
     params:
-     build: lf-git
+     build: lf-dockerfile
 
 - name: release
   plan:
@@ -43,8 +52,6 @@ jobs:
     params:
       GEM_API_KEY: ((LicenseFinderGemApiKey))
     file: lf-git/ci/tasks/build-and-push-gem.yml
-  - task: create-source-archives
-    file: lf-git/ci/tasks/create-source-archives.yml
   - put: lf-git
     params:
       repository: lf-git
@@ -57,4 +64,3 @@ jobs:
     params:
       name: version/tag.txt
       tag: version/tag.txt
-      globs: ["archives/*.zip", "archives/*.tar.gz"]

data/ci/scripts/containerize-tests.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+apk update && apk add git
+source /opt/resource/common.sh
+start_docker
+
+pushd LicenseFinder
+  if [ ! -z "$(git diff master Dockerfile)" ]; then
+    docker build . -t licensefinder/license_finder
+  fi
+
+  docker run -v $PWD:/lf -it licensefinder/license_finder /bin/bash \
+    -exlc "cd /lf && ci/scripts/run-tests.sh $RUBY_VERSION_UNDER_TEST"
+popd

data/ci/scripts/run-rubocop.sh

@@ -0,0 +1,8 @@
+#!/bin/bash -e
+
+cd LicenseFinder
+gem install rubocop
+
+
+echo "Running Rubocop ..."
+/usr/local/bundle/bin/rubocop

data/ci/scripts/run-tests.sh

@@ -0,0 +1,22 @@
+#!/bin/bash -elx
+RUBY_VERSION_UNDER_TEST=$1
+rvm install --default $RUBY_VERSION_UNDER_TEST
+ruby --version
+
+export GOPATH=$HOME/go
+export RUBYOPT='-E utf-8'
+
+gem update --system
+gem install bundler
+bundle install
+
+# jruby-9 specific: requires  >= rack 2.x
+if [ "$RUBY_VERSION_UNDER_TEST" == "jruby-9.0.4.0" ]
+then
+  bundle update rack
+fi
+#
+
+bundle exec rake install
+bundle exec rake spec
+bundle exec rake features

data/ci/scripts/test.ps1

@@ -0,0 +1,81 @@
+Set-PSDebug -strict # "set -u"
+$ErrorActionPreference = "Stop" # "set -e" for cmdlet errors
+
+# avoid overly narrow default linewrap
+$term = (get-host).ui.rawui
+$size = $term.buffersize
+$size.width = 128
+$term.buffersize = $size
+$size = $term.windowsize
+$size.width = 128
+$term.windowsize = $size
+
+function stream-cmd {
+    param ($command, $arguments)
+    $cmdline = "$($command) $($arguments)"
+    cmd /c $cmdline
+    if (-not ($?)) {
+        throw "$($cmdline) failed"
+    }
+}
+
+function prepend-path {
+    param ($dir)
+    $env:PATH = $dir + ";" + $env:PATH
+}
+
+function prepare-vm {
+    iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
+    choco install -y git ruby nodejs golang python2 erlang gradle maven
+    
+    $env:JAVA_HOME = 'C:\Program Files\Java\jdk1.8.0_144'
+    prepend-path 'C:\Program Files\Java\jdk1.8.0_144\bin'
+    prepend-path 'C:\tools\go\bin'
+    prepend-path 'C:\Program Files\Git\bin'
+    prepend-path 'C:\Program Files\erl9.0\bin'
+    stream-cmd "rmdir" "/s /q C:\rebar"
+    stream-cmd "git" "clone https://github.com/rebar/rebar C:\rebar"
+    stream-cmd "cd c:\rebar & .\bootstrap.bat" ""
+    stream-cmd "cp" "c:\rebar\rebar c:\tools"
+    stream-cmd "cp" "c:\rebar\rebar.cmd c:\tools"
+    prepend-path 'C:\tools'
+    mkdir -Force 'C:\Go'
+    mkdir -Force 'C:\Windows\system32\config\systemprofile\AppData\Local\Temp'
+    $env:GOPATH = 'C:\Go'
+    prepend-path 'C:\Go\bin'
+    stream-cmd "go" "get -d github.com/tools/godep"
+    prepend-path 'C:\Python27\Scripts'
+    prepend-path 'C:\Program Files\nodejs'
+    stream-cmd "npm" "install bower -g"
+    cp 'C:\Windows\System32\config\systemprofile\AppData\Roaming\npm\bower.cmd' 'C:\Program Files\nodejs'
+    cp -r 'C:\Windows\System32\config\systemprofile\AppData\Roaming\npm\node_modules\bower\*' 'C:\Program Files\nodejs\node_modules\bower' -Force
+    prepend-path 'C:\Ruby23\bin'
+    prepend-path 'C:\ProgramData\chocolatey\lib\gradle\tools\gradle-3.4.1\bin'
+    prepend-path 'C:\ProgramData\chocolatey\lib\maven\apache-maven-3.5.0\bin'
+}
+
+function set-env-vars {
+    prepend-path 'C:\Program Files\Java\jdk1.8.0_144\bin'
+    prepend-path 'C:\tools\go\bin'
+    prepend-path 'C:\Program Files\Git\bin'
+    prepend-path 'C:\Program Files\erl9.0\bin'
+    prepend-path 'C:\tools'
+    prepend-path 'C:\Go\bin'
+    prepend-path 'C:\Python27\Scripts'
+    prepend-path 'C:\Program Files\nodejs'
+    prepend-path 'C:\Ruby23\bin'
+}
+
+function run-tests {
+    set-env-vars
+    push-location LicenseFinder
+        stream-cmd "gem" "install bundler"
+        stream-cmd "bundle" "install"
+        stream-cmd "bundle" "exec rake install"
+        stream-cmd "bundle" "exec rake spec"
+        stream-cmd "bundle" "exec rake features"
+    pop-location
+}
+
+prepare-vm
+run-tests

data/ci/tasks/build-windows.yml

@@ -0,0 +1,6 @@
+platform: windows
+inputs:
+- name: LicenseFinder
+run:
+  path: powershell
+  args: ["-File", "LicenseFinder/ci/scripts/test.ps1"]

data/ci/tasks/build.yml

@@ -3,14 +3,14 @@ platform: linux
 image_resource:
   type: docker-image
   source:
-    repository: licensefinder/license_finder
+    repository: concourse/docker-image-resource
     tag: latest
 
 inputs:
 - name: LicenseFinder
 
 run:
-  path: ./LicenseFinder/ci/scripts/test.sh
+  path: ./LicenseFinder/ci/scripts/containerize-tests.sh
 
 params:
   RUBY_VERSION_UNDER_TEST:

data/ci/tasks/rubocop.yml

@@ -0,0 +1,13 @@
+platform: linux
+
+image_resource:
+  type: docker-image
+  source:
+    repository: ruby
+    tag: 2.4.1
+
+inputs:
+- name: LicenseFinder
+
+run:
+  path: ./LicenseFinder/ci/scripts/run-rubocop.sh

data/features/features/cli/cli_spec.rb

@@ -1,19 +1,19 @@
 require_relative '../../support/feature_helper'
 
-describe "License Finder command line executable" do
+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(:developer) { LicenseFinder::TestingDSL::User.new }
 
-  specify "shows usage and subcommand help" do
+  specify 'shows usage and subcommand help' do
     developer.create_empty_project
 
-    developer.execute_command "license_finder help"
+    developer.execute_command 'license_finder help'
     expect(developer).to be_seeing 'license_finder help [COMMAND]'
 
-    developer.execute_command "license_finder ignored_groups help add"
+    developer.execute_command 'license_finder ignored_groups help add'
     expect(developer).to be_seeing 'license_finder ignored_groups add GROUP'
   end
 
@@ -21,17 +21,17 @@ describe "License Finder command line executable" do
     developer.create_ruby_app # has license_finder as a dependency
 
     developer.run_license_finder
-    expect(developer).to be_seeing_something_like /license_finder.*MIT/
+    expect(developer).to be_seeing_something_like(/license_finder.*MIT/)
   end
 
   it "reports dependencies' licenses" do
     developer.create_ruby_app # has license_finder as a dependency, which has thor as a dependency
 
     developer.run_license_finder
-    expect(developer).to be_seeing_something_like /thor.*MIT/
+    expect(developer).to be_seeing_something_like(/thor.*MIT/)
   end
 
-  specify "runs default command" do
+  specify 'runs default command' do
     developer.create_empty_project
 
     developer.run_license_finder
@@ -39,7 +39,7 @@ describe "License Finder command line executable" do
     expect(developer).to be_seeing 'No dependencies recognized!'
   end
 
-  specify "displays an error if project_path does not exist" do
+  specify 'displays an error if project_path does not exist' do
     developer.create_empty_project
 
     path = '/path/that/does/not/exist'

data/features/features/configure/add_dependencies_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../support/feature_helper'
 
-describe "Manually Added Dependencies" do
+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 any official package manager
@@ -9,21 +9,21 @@ describe "Manually Added Dependencies" do
 
   before { developer.create_empty_project }
 
-  specify "appear in reports" do
+  specify 'appear in reports' do
     developer.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
 
     developer.run_license_finder
     expect(developer).to be_seeing 'manual_dep, 1.2.3, MIT'
   end
 
-  specify "can be simultaneously approved" do
+  specify 'can be simultaneously approved' do
     developer.execute_command 'license_finder dependencies add --approve manual Whatever'
 
     developer.run_license_finder
     expect(developer).not_to be_seeing 'manual_dep'
   end
 
-  specify "appear in the CLI" do
+  specify 'appear in the CLI' do
     developer.execute_command 'license_finder dependencies add manual_dep Whatever'
     expect(developer).to be_seeing 'manual_dep'
 
@@ -35,16 +35,16 @@ describe "Manually Added Dependencies" do
     expect(developer).to_not be_seeing 'manual_dep'
   end
 
-  specify "does not report dependencies that are manually removed" do
+  specify 'does not report dependencies that are manually removed' do
     developer.create_empty_project
-    developer.execute_command("license_finder dependencies add test_gem Random_License 0.0.1")
+    developer.execute_command('license_finder dependencies add test_gem Random_License 0.0.1')
 
     developer.run_license_finder
 
     expect(developer).to be_receiving_exit_code(1)
     expect(developer).to be_seeing 'test_gem'
 
-    developer.execute_command("license_finder dependencies remove test_gem")
+    developer.execute_command('license_finder dependencies remove test_gem')
 
     developer.run_license_finder
 

data/features/features/configure/approve_dependencies_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../support/feature_helper'
 
-describe "Manually Approved Dependencies" do
+describe 'Manually Approved Dependencies' do
   # As a developer
   # I want to approve dependencies without whitelisting their licenses
   # So that my business can track individual dependencies which it has approved
@@ -14,32 +14,32 @@ describe "Manually Approved Dependencies" do
     developer.execute_command "license_finder approval add manual_dep --who 'Julian' --why 'We really need this'"
   end
 
-  specify "do not appear in action items" do
+  specify 'do not appear in action items' do
     developer.run_license_finder
-    expect(developer).to_not be_seeing "manual_dep"
+    expect(developer).to_not be_seeing 'manual_dep'
   end
 
-  specify "include approval detail in reports" do
+  specify 'include approval detail in reports' do
     html = product_owner.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"
+    html.in_dep('manual_dep') do |section|
+      expect(section).to have_content 'Julian'
+      expect(section).to have_content 'We really need this'
     end
   end
 
-  specify "reports unapproved dependencies" do
+  specify 'reports unapproved dependencies' do
     developer.create_empty_project
-    developer.execute_command("license_finder dependencies add test_gem Random_License 0.0.1")
-    developer.execute_command("license_finder approvals add test_gem")
+    developer.execute_command('license_finder dependencies add test_gem Random_License 0.0.1')
+    developer.execute_command('license_finder approvals add test_gem')
 
     developer.run_license_finder
 
     expect(developer).to be_receiving_exit_code(0)
     expect(developer).not_to be_seeing 'test_gem'
 
-    developer.execute_command("license_finder approvals remove test_gem")
+    developer.execute_command('license_finder approvals remove test_gem')
 
     developer.run_license_finder
 
@@ -47,11 +47,11 @@ describe "Manually Approved Dependencies" do
     expect(developer).to be_seeing 'test_gem'
   end
 
-  specify "reports only unapproved dependencies, no approved dependencies" do
+  specify 'reports only unapproved dependencies, no approved dependencies' do
     developer.create_empty_project
-    developer.execute_command("license_finder dependencies add unapproved_gem Random_License 0.0.1")
-    developer.execute_command("license_finder dependencies add approved_gem Random_License 0.0.1")
-    developer.execute_command("license_finder approvals add approved_gem")
+    developer.execute_command('license_finder dependencies add unapproved_gem Random_License 0.0.1')
+    developer.execute_command('license_finder dependencies add approved_gem Random_License 0.0.1')
+    developer.execute_command('license_finder approvals add approved_gem')
 
     developer.run_license_finder
     expect(developer).to be_receiving_exit_code(1)

data/features/features/configure/assign_licenses_spec.rb

@@ -1,13 +1,13 @@
 require_relative '../../support/feature_helper'
 
-describe "Manually Assigned Licenses" do
+describe 'Manually Assigned Licenses' do
   # As a developer
   # I want to be able to override the licenses which license_finder finds
   # So that my dependencies all have the correct licenses
 
   let(:developer) { LicenseFinder::TestingDSL::User.new }
 
-  specify "are shown in cli after being added, and default license is not shown" do
+  specify 'are shown in cli after being added, and default license is not shown' do
     project = developer.create_ruby_app
     gem = developer.create_gem 'mislicensed_dep', license: 'Unknown'
     project.depend_on gem
@@ -18,7 +18,7 @@ describe "Manually Assigned Licenses" do
     expect(developer).to be_seeing_something_like /mislicensed_dep.*Known/
   end
 
-  specify "can be removed, revealing the default license for a dependency" do
+  specify 'can be removed, revealing the default license for a dependency' do
     project = developer.create_ruby_app
     gem = developer.create_gem 'mislicensed_dep', license: 'Default'
     project.depend_on gem
@@ -32,4 +32,4 @@ describe "Manually Assigned Licenses" do
     developer.run_license_finder
     expect(developer).to be_seeing_something_like /mislicensed_dep.*Default/
   end
-end
+end

data/features/features/configure/blacklist_licenses_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../support/feature_helper'
 
-describe "Blacklisted licenses" do
+describe 'Blacklisted licenses' do
   # As a lawyer
   # I want to blacklist certain licenses
   # So that any dependencies with only these licenses cannot be approved
@@ -14,14 +14,14 @@ describe "Blacklisted licenses" do
     developer.execute_command 'license_finder dependencies add blacklisted_dep BSD'
   end
 
-  specify "prevent packages from being approved" do
+  specify 'prevent packages from being approved' do
     developer.execute_command 'license_finder approval add blacklisted_dep'
 
     lawyer.run_license_finder
     expect(lawyer).to be_seeing 'blacklisted_dep'
   end
 
-  specify "override the whitelist" do
+  specify 'override the whitelist' do
     developer.execute_command 'license_finder whitelist add BSD'
 
     lawyer.run_license_finder