google-cloud-env 1.0.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fba900d98b872b7f9de91312f5b169695eebcd395df5080f348b41358f45d3
-  data.tar.gz: 5b14af4d3681740366160c09e6a93d707fe3a6c4c4f866bd1c93ea1c35a76037
+  metadata.gz: 2fe4fb0b390a089e7efb8cde45fb7f6df9e86b25ab81b84292a67fe481341137
+  data.tar.gz: 5efcbb333c4796812b99332cfc9919ae00f1e39104f092edc1392ba558d40caf
 SHA512:
-  metadata.gz: 1fe82152bd2fdfafbe25a1d00ce3986757917c535a71630a5d32af0bdc7feb120567dd7fbf14a123f44957ca56519de8e2d176ce0084f6902f6182decb60242e
-  data.tar.gz: a146cfd531bd36e4e517a385b3e7b8f252623a68727dff53bb453e6518e1b98236032d90d96b58bd79315b109355e74b4cc6f87f95bac607758674dcf2dbad62
+  metadata.gz: b74d450efba00970ed06f659dbedca0391f3128bb9ce6e0abb7d5580c18d55fd58a65ac81ffb6be5a10bc4b07ca41c9121f32df1ef87de455b96993d716150f0
+  data.tar.gz: 2dde707316115cda0096dbc949d8a6f8dae5f4110540a986bcb89aa1cbd258aebc496ca159b4a47f17fc2dda4277ac0d83c332a9519186451ec027f67633ca0d

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release History
 
+### 1.3.0 / 2019-10-23
+
+Now requires Ruby 2.4 or later.
+
+#### Features
+
+* Recognize App Engine Standard and Knative
+
+### 1.2.1 / 2019-08-23
+
+#### Bug Fixes
+
+* Send Metadata-Flavor header when testing the metadata server root
+
+#### Documentation
+
+* Update documentation
+
+### 1.2.0 / 2019-06-19
+
+* Support separate timeout for connecting to the metadata server vs the entire request
+
+### 1.1.0 / 2019-05-29
+
+* Support disabling of the metadata cache
+* Support configurable retries when querying the metadata server
+* Support configuration of the metadata request timeout
+
 ### 1.0.5 / 2018-09-20
 
 * Update documentation.

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-env console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-env requires Ruby 2.3+. You may choose to
+1. Install Ruby. google-cloud-env requires Ruby 2.4+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).

data/README.md

@@ -3,15 +3,15 @@
 This library provides information on the application hosting environment for
 apps running on Google Cloud Platform.
 
-- [google-cloud-env API documentation](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest)
+- [google-cloud-env API documentation](https://googleapis.dev/ruby/google-cloud-env/latest)
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.3+.
+This library is supported on Ruby 2.4+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
-security maintenance, and not end of life. Currently, this means Ruby 2.3 and
+security maintenance, and not end of life. Currently, this means Ruby 2.4 and
 later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
@@ -28,18 +28,18 @@ change at any time and the public API should not be considered stable.
 Contributions to this library are always welcome and highly encouraged.
 
 See the [Contributing
-Guide](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.CONTRIBUTING)
+Guide](https://googleapis.dev/ruby/google-cloud-env/latest/file.CONTRIBUTING.html)
 for more information on how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By
 participating in this project you agree to abide by its terms. See [Code of
-Conduct](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.CODE_OF_CONDUCT)
+Conduct](https://googleapis.dev/ruby/google-cloud-env/latest/file.CODE_OF_CONDUCT.html)
 for more information.
 
 ## License
 
 This library is licensed under Apache 2.0. Full license text is available in
-[LICENSE](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.LICENSE).
+[LICENSE](https://googleapis.dev/ruby/google-cloud-env/latest/file.LICENSE.html).
 
 ## Support
 

data/lib/google/cloud/env.rb

@@ -65,22 +65,66 @@ module Google
       # @private URL path for metadata server root.
       METADATA_ROOT_PATH = "/".freeze
 
+      # @private
+      METADATA_FAILURE_EXCEPTIONS = [
+        Faraday::TimeoutError,
+        Faraday::ConnectionFailed,
+        Errno::EHOSTDOWN,
+        Errno::ETIMEDOUT,
+        Timeout::Error
+      ].freeze
+
       ##
       # Create a new instance of the environment information.
       # Most client should not need to call this directly. Obtain a singleton
       # instance of the information from `Google::Cloud.env`. This constructor
-      # is provided for internal testing and allows mocking of the data.
+      # is provided to allow customization of the timeout/retry settings, as
+      # well as mocking for testing.
       #
       # @param [Hash] env Mock environment variables.
+      # @param [Hash,false] metadata_cache The metadata cache. You may pass
+      #     a prepopuated cache, an empty cache (the default) or `false` to
+      #     disable the cache completely.
+      # @param [Numeric] open_timeout Timeout for opening http connections.
+      #     Defaults to 0.1.
+      # @param [Numeric] request_timeout Timeout for entire http requests.
+      #     Defaults to 1.0.
+      # @param [Integer] retry_count Number of times to retry http requests.
+      #     Defaults to 1. Note that retry remains in effect even if a custom
+      #     `connection` is provided.
+      # @param [Numeric] retry_interval Time between retries in seconds.
+      #     Defaults to 0.1.
+      # @param [Numeric] retry_backoff_factor Multiplier applied to the retry
+      #     interval on each retry. Defaults to 1.5.
+      # @param [Numeric] retry_max_interval Maximum time between retries in
+      #     seconds. Defaults to 0.5.
       # @param [Faraday::Connection] connection Faraday connection to use.
-      # @param [Hash] metadata_cache Mock cache.
-      #
-      def initialize env: nil, connection: nil, metadata_cache: nil
+      #     If specified, overrides the `request_timeout` and `open_timeout`
+      #     settings.
+      #
+      def initialize env: nil, connection: nil, metadata_cache: nil,
+                     open_timeout: 0.1, request_timeout: 1.0,
+                     retry_count: 2, retry_interval: 0.1,
+                     retry_backoff_factor: 1.5, retry_max_interval: 0.5
+        @disable_metadata_cache = metadata_cache == false
         @metadata_cache = metadata_cache || {}
         @env = env || ::ENV
-        @connection = connection ||
-                      ::Faraday.new(url: METADATA_HOST,
-                                    request: { timeout: 0.1 })
+        @retry_count = retry_count
+        @retry_interval = retry_interval
+        @retry_backoff_factor = retry_backoff_factor
+        @retry_max_interval = retry_max_interval
+        request_opts = { timeout: request_timeout, open_timeout: open_timeout }
+        @connection = connection || ::Faraday.new(url: METADATA_HOST, request: request_opts)
+      end
+
+      ##
+      # Determine whether the application is running on a Knative-based
+      # hosting platform, such as Cloud Run or Cloud Functions.
+      #
+      # @return [Boolean]
+      #
+      def knative?
+        env["K_SERVICE"] ? true : false
       end
 
       ##
@@ -92,6 +136,26 @@ module Google
         env["GAE_INSTANCE"] ? true : false
       end
 
+      ##
+      # Determine whether the application is running on Google App Engine
+      # Flexible Environment.
+      #
+      # @return [Boolean]
+      #
+      def app_engine_flexible?
+        app_engine? && env["GAE_ENV"] != "standard"
+      end
+
+      ##
+      # Determine whether the application is running on Google App Engine
+      # Standard Environment.
+      #
+      # @return [Boolean]
+      #
+      def app_engine_standard?
+        app_engine? && env["GAE_ENV"] == "standard"
+      end
+
       ##
       # Determine whether the application is running on Google Kubernetes
       # Engine (GKE).
@@ -136,7 +200,7 @@ module Google
       # @return [Boolean]
       #
       def raw_compute_engine?
-        !app_engine? && !cloud_shell? && metadata? && !kubernetes_engine?
+        !knative? && !app_engine? && !cloud_shell? && metadata? && !kubernetes_engine?
       end
 
       ##
@@ -146,8 +210,7 @@ module Google
       # @return [String,nil]
       #
       def project_id
-        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] ||
-          lookup_metadata("project", "project-id")
+        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] || lookup_metadata("project", "project-id")
       end
 
       ##
@@ -249,6 +312,27 @@ module Google
         lookup_metadata "instance", "attributes/#{key}"
       end
 
+      ##
+      # Returns the name of the running Knative service, or `nil` if the
+      # current code is not running on Knative.
+      #
+      # @return [String,nil]
+      #
+      def knative_service_id
+        env["K_SERVICE"]
+      end
+      alias knative_service_name knative_service_id
+
+      ##
+      # Returns the revision of the running Knative service, or `nil` if the
+      # current code is not running on Knative.
+      #
+      # @return [String,nil]
+      #
+      def knative_service_revision
+        env["K_REVISION"]
+      end
+
       ##
       # Returns the name of the running App Engine service, or `nil` if the
       # current code is not running in App Engine.
@@ -258,6 +342,7 @@ module Google
       def app_engine_service_id
         env["GAE_SERVICE"]
       end
+      alias app_engine_service_name app_engine_service_id
 
       ##
       # Returns the version of the running App Engine service, or `nil` if the
@@ -305,8 +390,7 @@ module Google
         # below is set in some older versions of GKE, and the file below is
         # present in Kubernetes as of version 1.9, but it is possible that
         # alternatives will need to be found in the future.
-        env["GKE_NAMESPACE_ID"] ||
-          ::IO.read("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
+        env["GKE_NAMESPACE_ID"] || ::IO.read("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
       rescue SystemCallError
         nil
       end
@@ -318,17 +402,16 @@ module Google
       # @return [Boolean]
       #
       def metadata?
-        unless metadata_cache.include?(METADATA_ROOT_PATH)
-          begin
-            resp = connection.get METADATA_ROOT_PATH
-            metadata_cache[METADATA_ROOT_PATH] = \
-              resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
-          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed,
-                 Errno::EHOSTDOWN
-            metadata_cache[METADATA_ROOT_PATH] = false
+        path = METADATA_ROOT_PATH
+        if @disable_metadata_cache || !metadata_cache.include?(path)
+          metadata_cache[path] = retry_or_fail_with false do
+            resp = connection.get path do |req|
+              req.headers = { "Metadata-Flavor" => "Google" }
+            end
+            resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
           end
         end
-        metadata_cache[METADATA_ROOT_PATH]
+        metadata_cache[path]
       end
 
       ##
@@ -342,16 +425,15 @@ module Google
       # @return [String,nil]
       #
       def lookup_metadata type, entry
+        return nil unless metadata?
+
         path = "#{METADATA_PATH_BASE}/#{type}/#{entry}"
-        if !metadata_cache.include?(path) && metadata?
-          begin
+        if @disable_metadata_cache || !metadata_cache.include?(path)
+          metadata_cache[path] = retry_or_fail_with nil do
             resp = connection.get path do |req|
               req.headers = { "Metadata-Flavor" => "Google" }
             end
-            metadata_cache[path] = resp.status == 200 ? resp.body.strip : nil
-          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed,
-                 Errno::EHOSTDOWN
-            metadata_cache[path] = nil
+            resp.status == 200 ? resp.body.strip : nil
           end
         end
         metadata_cache[path]
@@ -371,6 +453,23 @@ module Google
       attr_reader :connection
       attr_reader :env
       attr_reader :metadata_cache
+
+      def retry_or_fail_with error_result
+        retries_remaining = @retry_count
+        retry_interval = @retry_interval
+        begin
+          yield
+        rescue *METADATA_FAILURE_EXCEPTIONS
+          retries_remaining -= 1
+          if retries_remaining >= 0
+            sleep retry_interval
+            retry_interval *= @retry_backoff_factor
+            retry_interval = @retry_max_interval if retry_interval > @retry_max_interval
+            retry
+          end
+          error_result
+        end
+      end
     end
 
     @env = Env.new

data/lib/google/cloud/env/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     class Env
-      VERSION = "1.0.5".freeze
+      VERSION = "1.3.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,63 +25,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: autotest-suffix
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,33 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -195,15 +195,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.