gcp_data 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398e39c8a777684e03619a5941d86c1f2b683093919d5c8d3bf14a411078b375
-  data.tar.gz: f1ffef56aa9e2281c0415f161b30542dd21c1fdfa73356f5a21e4bf1a4f230bc
+  metadata.gz: 1e4fe524be4163e8b796361a35270f4e0230f1908b1380d58d17063ec5dbb01b
+  data.tar.gz: 0fb3fde5e05fb32529666d1b83eaa50fbef7db2c40ba15cfd28a9c89cbc4c2d0
 SHA512:
-  metadata.gz: 84e03b633b383e974a172816f417d7aa3b748d579ae0c9f03ee258b0f2828e9ff42da2b167afb4c076f7fcc97bd626c5cf5845096ddac277274073ee60872ccf
-  data.tar.gz: 21fa79d030a23a613707f842144e21bbbeba9d3b97cb855ff5062a95af3f655670bf4161a76e78fe54cf6ecf7597f40d544d89d27ed6eccbc9f6ff9808556425
+  metadata.gz: 2f82401965e69cf29d9b18e5b3956c305b4f4c033eb31a63680193917e9ee93b34620b3830c980d9cea51bd05a5d3441e23287e392279857bba4e895aba094b9
+  data.tar.gz: db5b4acea8d9dcda32b74fc4735a5f5919e383d69bf32f70abdd0cbb9b53fb459ff8a07b9c24af61abff441d54b77404c0aaf52b303dfa226d85fdf98f03bf69

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [0.2.1] - 2021-12-27
+- [#2](https://github.com/tongueroo/gcp_data/pull/2) friendly error message when gcloud cli not installed
+- [#3](https://github.com/tongueroo/gcp_data/pull/3) autoset GOOGLE_PROJECT GOOGLE_REGION GOOGLE_ZONE from gcloud config o…
+
 ## [0.2.0]
 - #1 additional precedence lookups
 

data/README.md

@@ -29,11 +29,11 @@ GcpData.region
 
 ## Precedence
 
-This library will return prjoect and region info using different sources with this precedence:
+This library will return project and region info using different sources with this precedence:
 
 1. Environment variables: GOOGLE_PROJECT, GOOGLE_REGION, GOOGLE_ZONE
 2. Google Credentials file: only project id available from the GOOGLE\_APPLICATION_CREDENTIALS file
-3. CLI: gcloud
+3. CLI: gcloud: project, region, and zone available
 4. Defaults: region=us-central1 and zone==us-central1a
 
 ### 1. Environment variables
@@ -68,11 +68,11 @@ The commands saves to a file in ~/.config/gcloud. The file looks something like
 
 ### 4. Defaults
 
-The library will fallback to default values when it's unable to lookup the region and zone. The default values are:
+The library will fall back to default values when it's unable to lookup the region and zone. The default values are:
 
     region=us-central1
     zone==us-central1a
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/gcp_data.
+Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/gcp_data.

data/lib/gcp_data/version.rb

@@ -1,3 +1,3 @@
 module GcpData
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/gcp_data.rb

@@ -6,17 +6,17 @@ module GcpData
   extend Memoist
 
   def project
-    ENV['GOOGLE_PROJECT'] || creds("project_id") || gcloud_config("core/project") || raise("Unable to look up google project_id")
+    ENV['GOOGLE_PROJECT'] ||= gcloud_config("core/project") || creds("project_id") || raise("Unable to look up google project_id")
   end
   memoize :project
 
   def region
-    ENV['GOOGLE_REGION'] || gcloud_config("compute/region") || 'us-central1'
+    ENV['GOOGLE_REGION'] ||= gcloud_config("compute/region") || 'us-central1'
   end
   memoize :region
 
   def zone
-    ENV['GOOGLE_ZONE'] || gcloud_config("compute/zone") || 'us-central1a'
+    ENV['GOOGLE_ZONE'] ||= gcloud_config("compute/zone") || 'us-central1a'
   end
   memoize :zone
 
@@ -31,15 +31,67 @@ module GcpData
   memoize :credentials
 
   def gcloud_config(key)
-    check_gcloud_installed!
-    val = `gcloud config get-value #{key}`.strip
-    val unless val == ''
+    if gcloud_installed?
+      # redirect stderr to stdout because (unset) is printed to stderr when a value is not set. IE:
+      #
+      #   $ gcloud config get-value compute/region
+      #   (unset)
+      #
+      command = "gcloud config get-value #{key} 2>&1"
+      puts "RUNNING: #{command}" if ENV['GCP_DATA_DEBUG']
+      val = `#{command}`.strip
+      val unless ['', '(unset)'].include?(val)
+    elsif !env_vars_set?
+      error_message
+    end
   end
 
-  def check_gcloud_installed!
-    installed = system("type gcloud > /dev/null 2>&1")
-    return if installed
-    raise Error.new("ERROR: gcloud is not installed. Please install the gcloud command.")
+  def gcloud_installed?
+    system("type gcloud > /dev/null 2>&1")
+  end
+
+  def env_vars
+    %w[
+      GOOGLE_APPLICATION_CREDENTIALS
+      GOOGLE_PROJECT
+      GOOGLE_REGION
+    ]
+  end
+
+  def env_vars_set?
+    env_vars.all? { |var| ENV[var] }
+  end
+
+  def error_message(message=nil)
+    all_vars = format_list(env_vars)
+    unset_vars = format_list(env_vars.reject { |var| ENV[var] })
+    message ||= <<~EOL
+      ERROR: gcloud is not installed. Please install the gcloud CLI and configure it.
+      GcpData uses it to detect google cloud project, region, zone.
+
+      You can also configure these environment variables instead of installing the google CLI.
+
+      #{all_vars}
+
+      Currently, the unset vars are:
+
+      #{unset_vars}
+
+    EOL
+    show_error(message)
+  end
+
+  def show_error(message)
+    if ENV['GCP_DATA_RAISE_ERROR']
+      raise Error.new(message)
+    else
+      puts message
+      exit 1
+    end
+  end
+
+  def format_list(vars)
+    vars.map { |var| "    #{var}" }.join("\n")
   end
 
   extend self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gcp_data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoist
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Simple module to get current gcp data project and region