licensed 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1985113209d911393981eb8f69dfaae7f5924593
-  data.tar.gz: e7ba321109bae085d9345e41c599370e24547fb2
+  metadata.gz: 87be3d9de274a4f66698f8880f5c858c2733c35f
+  data.tar.gz: eb8125c0b348a042e814bf72732e1fbdce0e4426
 SHA512:
-  metadata.gz: a5046d1ebce6f3b386d94b8e0606e3ad1b7d93eba73bc94d37e2fa933129f649ea3efca557fe828386aedda310e40d796b32ddac9aa1f2dbaa95bc0c0ca8db1d
-  data.tar.gz: ec5ccf83bb05ba32038a7a45092f236be2835e1947959c3fcd8c67c8f0d25b92d1e7ff82cfe927204af3d1c5fe2c19ca1fb9afd6d680e058d4bc3530ec4fdbb4
+  metadata.gz: 53376c057796cd662142d49b5122101d70d6ffc759f945d2da2d26ef0c72f403e5b07a92c8d367aecfcd1f0efa4706a893035d6f9671cb3bddaa948707b05b1b
+  data.tar.gz: ceff661d0fdfda3bfb0920cf246cce9220a13c7675e1547b8be6c3ae8d9f29bb2e78e5541e56c3af3d388a16b5944adb11324e6191afb19d9c9cf95c8aa7086f

data/.gitignore

@@ -18,6 +18,7 @@ test/fixtures/npm/package-lock.json
 test/fixtures/go/src/*
 test/fixtures/go/pkg
 !test/fixtures/go/src/test
+!test/fixtures/go/src/modules_test
 test/fixtures/cabal/*
 !test/fixtures/cabal/app*
 test/fixtures/git_submodule/*

data/.travis.yml

@@ -13,14 +13,20 @@ matrix:
       go: "1.7.x"
       before_script: ./script/source-setup/go
       script: ./script/test go
-      env: NAME="go"
+      env: NAME="go 1.7.x"
 
     # go 1.10 tests
     - language: go
       go: "1.10.x"
       before_script: ./script/source-setup/go
       script: ./script/test go
-      env: NAME="go"
+      env: NAME="go 1.10.x"
+
+    - language: go
+      go: "1.11.1"
+      before_script: ./script/source-setup/go
+      script: ./script/test go
+      env: NAME="go 1.11.1"
 
     # dep tests
     - language: go

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## 1.5.2 - 2018-12-27
+
+### Changes
+- Go source added support for Go modules and Golang 1.11+ (https://github.com/github/licensed/pull/113)
+
+### Fixed
+- Licensed will have a non-zero exit code when commands fail (:tada: @parkr https://github.com/github/licensed/pull/111)
+
 ## 1.5.1 - 2018-10-30
 
 ### Fixed
@@ -104,4 +112,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Initial release :tada:
 
-[Unreleased]: https://github.com/github/licensed/compare/1.5.1...HEAD
+[Unreleased]: https://github.com/github/licensed/compare/1.5.2...HEAD

data/README.md

@@ -91,16 +91,16 @@ See the [configuration file documentation](./docs/configuration.md) for more det
 
 ### Sources
 
-Dependencies will be automatically detected for
-1. [Bower](./docs/sources/bower.md)
+Dependencies will be automatically detected for all of the following sources by default.
+1. [Bower (bower)](./docs/sources/bower.md)
 2. [Bundler (rubygem)](./docs/sources/bundler.md)
-3. [Cabal](./docs/sources/cabal.md)
-4. [Go](./docs/sources/go.md)
-5. [Go Dep](./docs/sources/dep.md)
-6. [Manifest lists](./docs/sources/manifests.md)
-7. [NPM](./docs/sources/npm.md)
-8. [Pip](./docs/sources/pip.md)
-9. [Git Submodules](./docs/sources/git_submodule.md)
+3. [Cabal (cabal)](./docs/sources/cabal.md)
+4. [Go (go)](./docs/sources/go.md)
+5. [Go Dep (dep)](./docs/sources/dep.md)
+6. [Manifest lists (manifests)](./docs/sources/manifests.md)
+7. [NPM (npm)](./docs/sources/npm.md)
+8. [Pip (pip)](./docs/sources/pip.md)
+9. [Git Submodules (git_submodule)](./docs/sources/git_submodule.md)
 
 You can disable any of them in the configuration file:
 

data/docs/sources/pip.md

@@ -16,6 +16,7 @@ _note_: `<your_venv_dir>` path should be relative to the repository root or can
 #### virtual_env_dir (Required)
 
 The `pip` command will be sourced from this directory.
+You have to add this setting to your licensed configuration file.
 An example usage of this might look like:
 ```yaml
 python:

data/lib/licensed/cli.rb

@@ -37,6 +37,11 @@ module Licensed
       run Licensed::Command::Version.new
     end
 
+    # If an error occurs (e.g. a missing command or argument), exit 1.
+    def self.exit_on_failure?
+      true
+    end
+
     private
 
     # Returns a configuration object for the CLI command

data/lib/licensed/source/go.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require "json"
-require "English"
 require "pathname"
 
 module Licensed
@@ -20,15 +19,8 @@ module Licensed
 
       def dependencies
         @dependencies ||= with_configured_gopath do
-          packages.map do |package_name|
-            package = package_info(package_name)
-            import_path = non_vendored_import_path(package_name)
-
-            if package.empty?
-              next if @config.ignored?("type" => Go.type, "name" => package_name)
-              raise "couldn't find package for #{import_path}"
-            end
-
+          packages.map do |package|
+            import_path = non_vendored_import_path(package["ImportPath"])
             package_dir = package["Dir"]
             Dependency.new(package_dir, {
               "type"        => Go.type,
@@ -36,19 +28,88 @@ module Licensed
               "summary"     => package["Doc"],
               "homepage"    => homepage(import_path),
               "search_root" => search_root(package_dir),
-              "version"     => package_version(package_dir)
+              "version"     => package_version(package)
             })
-          end.compact
+          end
+        end
+      end
+
+      # Returns an array of dependency package import paths
+      def packages
+        dependency_packages = if go_version < Gem::Version.new("1.11.0")
+          root_package_deps
+        else
+          go_list_deps
+        end
+
+        # don't include go std packages
+        # don't include packages under the root project that aren't vendored
+        dependency_packages
+          .reject { |pkg| go_std_package?(pkg) }
+          .reject { |pkg| local_package?(pkg) }
+      end
+
+      # Returns non-ignored packages found from the root packages "Deps" property
+      def root_package_deps
+        # check for ignored packages to avoid raising errors calling `go list`
+        # when ignored package is not found
+        Array(root_package["Deps"])
+          .reject { |name| @config.ignored?("type" => Go.type, "name" => name) }
+          .map { |name| package_info(name) }
+      end
+
+      # Returns the list of dependencies as returned by "go list -json -deps"
+      # available in go 1.11
+      def go_list_deps
+        @go_list_deps ||= begin
+          deps = package_info_command("-deps")
+          # the CLI command returns packages in a pretty-printed JSON format but
+          # not separated by commas. this gsub adds commas after all non-indented
+          # "}" that close root level objects.
+          # (?!\z) uses negative lookahead to not match the final "}"
+          deps.gsub!(/^}(?!\z)$/m, "},")
+          JSON.parse("[#{deps}]")
+            .reject { |pkg| @config.ignored?("type" => Go.type, "name" => pkg["ImportPath"]) }
+            .each { |pkg| raise pkg.dig("Error", "Err") if pkg["Error"] }
         end
       end
 
-      # Returns the most recent git SHA for a package, or nil if SHA is
-      # not available
+      # Returns whether the given package import path belongs to the
+      # go std library or not
       #
-      # package_directory - package location
-      def package_version(package_directory)
+      # package - package to check as part of the go standard library
+      def go_std_package?(package)
+        return false unless package
+        return true if package["Standard"]
+
+        import_path = package["ImportPath"]
+        return false unless import_path
+
+        # modify the import path to look like the import path `go list` returns for vendored std packages
+        std_vendor_import_path = import_path.sub(%r{^#{root_package["ImportPath"]}/vendor/golang.org}, "vendor/golang_org")
+        go_std_packages.include?(import_path) || go_std_packages.include?(std_vendor_import_path)
+      end
+
+      # Returns whether the package is local to the current project
+      def local_package?(package)
+        return false unless package && package["ImportPath"]
+        import_path = package["ImportPath"]
+        import_path.start_with?(root_package["ImportPath"]) && !vendored_path?(import_path)
+      end
+
+      # Returns the version for a given package
+      #
+      # package - package to get version of
+      def package_version(package)
+        # use module version if it exists
+        go_mod = package["Module"]
+        return go_mod["Version"] if go_mod
+
+        package_directory = package["Dir"]
         return unless package_directory
 
+        # find most recent git SHA for a package, or nil if SHA is
+        # not available
         Dir.chdir package_directory do
           Licensed::Git.version(".")
         end
@@ -64,25 +125,6 @@ module Licensed
         "https://#{import_path}"
       end
 
-      # Returns an array of dependency package import paths
-      def packages
-        return [] unless root_package["Deps"]
-
-        # don't include go std packages
-        # don't include packages under the root project that aren't vendored
-        root_package["Deps"]
-          .uniq
-          .select { |d| !go_std_packages.include?(d) }
-          .select { |d| !d.start_with?(root_package["ImportPath"]) || vendored_path?(d) }
-          .select do |d|
-          # this removes the packages listed in `go list std` as "vendor/golang_org/*" but are vendored
-          # as "vendor/golang.org/*"
-            go_std_packages.none? do |std_pkg|
-              std_pkg.sub(%r{^vendor/golang_org/}, "#{root_package["ImportPath"]}/vendor/golang.org/") == d
-            end
-          end
-      end
-
       # Returns the root directory to search for a package license
       #
       # package - package object obtained from package_info
@@ -112,31 +154,28 @@ module Licensed
         import_path.split("vendor/")[1]
       end
 
-      # Returns package information, or {} if package isn't found
+      # Returns a hash of information about the package with a given import path
       #
-      # package - Go package import path
-      def package_info(package = nil)
-        info = package_info_command(package)
-        return {} if info.empty?
-        JSON.parse(info)
+      # import_path - Go package import path
+      def package_info(import_path)
+        JSON.parse(package_info_command(import_path))
       end
 
       # Returns package information as a JSON string
       #
-      # package - Go package import path
-      def package_info_command(package)
-        package ||= ""
-        Licensed::Shell.execute("go", "list", "-json", package, allow_failure: true)
+      # args - additional arguments to `go list`, e.g. Go package import path
+      def package_info_command(*args)
+        Licensed::Shell.execute("go", "list", "-json", *Array(args)).strip
       end
 
       # Returns the info for the package under test
       def root_package
-        @root_package ||= package_info
+        @root_package ||= package_info(".")
       end
 
       # Returns whether go source is found
       def go_source?
-        @go_source ||= with_configured_gopath { Licensed::Shell.success?("go", "doc") }
+        with_configured_gopath { Licensed::Shell.success?("go", "doc") }
       end
 
       # Returns a list of go standard packages
@@ -162,6 +201,15 @@ module Licensed
                   end
       end
 
+      # Returns the current version of go available, as a Gem::Version
+      def go_version
+        @go_version ||= begin
+          full_version = Licensed::Shell.execute("go", "version").strip
+          version_string = full_version.gsub(%r{.*go(\d+\.\d+(\.\d+)?).*}, "\\1")
+          Gem::Version.new(version_string)
+        end
+      end
+
       private
 
       # Execute a block with ENV["GOPATH"] set to the value of #gopath.

data/lib/licensed/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Licensed
-  VERSION = "1.5.1".freeze
+  VERSION = "1.5.2".freeze
 end

data/script/source-setup/go

@@ -12,8 +12,20 @@ export GOPATH="$BASE_PATH/test/fixtures/go"
 cd $BASE_PATH/test/fixtures/go
 
 if [ "$1" == "-f" ]; then
-  find . -not -regex "\.*" -and -not -path "*/src/test*" -and -not -path "*/src" -print0 | xargs -0 rm -rf
+  find . -not -regex "\.*" \
+    -and -not -path "*/src/test*" \
+    -and -not -path "*/src/modules_test*" \
+    -and -not -path "*/pkg/mod*" \
+    -and -not -path "*/pkg" \
+    -and -not -path "*/src" \
+    -print0 | xargs -0 rm -rf
+
+  if go help mod >/dev/null; then
+    go clean -modcache
+  fi
 fi
 
-cd src/test
-go get
+(cd src/test && go get)
+if go help mod >/dev/null; then
+  (cd src/modules_test && GO111MODULE=on go mod download)
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensed
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: licensee