azure_info 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 646dd5f9bdd9dde86186dfbe79c9830f0350580f22ee314ddd25a5e35ad4542e
-  data.tar.gz: 4d40f19ff4c6d1651871d43436c7e8901ce917fa75c1cf506a3c4ba132ecf530
+  metadata.gz: e4ae9c9490f68fe1f75f04f8c4ad05adb4c4c3ddbe4723563e33739723c13f64
+  data.tar.gz: f463b07527a94b6851fefa659e568a9d4d59c1d0496dd136e62067a8bdf8d4f3
 SHA512:
-  metadata.gz: 2a9dc4214da271076da2f09dea0388d9a27ec32e3fb120e4d0b8197d46c17aaf941514cb46a01d9567a1f7e2c6f0357fc1bac60d5d08adeae86b156fd0f471f1
-  data.tar.gz: 8aeee66d296a7c30fad2ecce720c85c6fc41d83d8d23e9ad21e49ed0e6b50e8858348340e2057bcbc42e9760c5230aa27aec9ada09cedb523a3d9daa509c68b9
+  metadata.gz: 5ea982a5564f29622a740324a6459ea316f4b174ef6723e4e1859ea6f8ed759909a930dda066d3680989972d2358a721e3d2ab57c28c62db6c554fce155c4b57
+  data.tar.gz: a82b55909878ea8bf6a00db2829762fb6c0632c0ef9d59b336cd8c8bc6ffa087526a52aacca18a883ba416b742be8ebb8ed6c09ba754fde4997127e33cde865f

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.1.4] - 2021-12-27
+- [#4](https://github.com/boltops-tools/azure_info/pull/4) improve error message when az cli not installed
+
 ## [0.1.3] - 2021-12-27
 - [#3](https://github.com/boltops-tools/azure_info/pull/3) improve error message when az cli not installed
 - comment about what is used in the account and configure object

data/lib/azure_info/account.rb

@@ -1,5 +1,5 @@
 module AzureInfo
-  class Account < Base
+  class Account
     def get(name)
       az_account_show[name]
     end

data/lib/azure_info/configure.rb

@@ -3,20 +3,74 @@
 #     az configure --defaults location=westus2 group=MyResourceGroup
 #
 module AzureInfo
-  class Configure < Base
+  class Configure
     def get(name)
-      item = az_configure_list_defaults.find do |i|
+      item = azure_configs.find do |i|
         i["name"] == name
       end
       item["value"] if item
     end
 
+  private
     # looks like az configure stores settings in  ~/.azure/config
-    def az_configure_list_defaults
-      return @az_configure_list_defaults if @az_configure_list_defaults
-      check_az_installed!
-      out = `az configure --list-defaults --output json`.strip
-      @az_configure_list_defaults = JSON.load(out)
+    def azure_configs
+      if az_installed?
+        return @azure_configs if @azure_configs
+        out = `az configure --list-defaults --output json`.strip
+        @azure_configs = JSON.load(out)
+      else
+        if env_vars_set?
+          []
+        else
+          error_message
+        end
+      end
+    end
+
+    def az_installed?
+      system("type az > /dev/null 2>&1")
+    end
+
+    def env_vars
+      %w[
+        ARM_CLIENT_ID
+        ARM_CLIENT_SECRET
+        ARM_LOCATION
+        ARM_SUBSCRIPTION_ID
+        ARM_TENANT_ID
+      ]
+    end
+
+    def env_vars_set?
+      env_vars.all? { |var| ENV[var] }
+    end
+
+    def error_message
+      all_vars = format_list(env_vars)
+      unset_vars = format_list(env_vars.reject { |var| ENV[var] })
+      message = <<~EOL
+        ERROR: az is not installed. Please install the az command and configure it.
+        AzureInfo uses it to detect azure resource group, location, subscription id, and tenant id.
+
+        You can also configure these environment variables instead of installing the az cli.
+
+        #{all_vars}
+
+        Currently, the unset vars are:
+
+        #{unset_vars}
+
+      EOL
+      if ENV['AZ_INFO_RAISE_ERROR']
+        raise Error.new(message)
+      else
+        puts message
+        exit 1
+      end
+    end
+
+    def format_list(vars)
+      vars.map { |var| "    #{var}" }.join("\n")
     end
   end
 end

data/lib/azure_info/version.rb

@@ -1,3 +1,3 @@
 module AzureInfo
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure_info
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Tung Nguyen
@@ -29,7 +29,6 @@ files:
 - bin/setup
 - lib/azure_info.rb
 - lib/azure_info/account.rb
-- lib/azure_info/base.rb
 - lib/azure_info/configure.rb
 - lib/azure_info/version.rb
 homepage: https://github.com/boltops-tools/azure_info

data/lib/azure_info/base.rb

@@ -1,26 +0,0 @@
-module AzureInfo
-  class Base
-    def check_az_installed!
-      installed = system("type az > /dev/null 2>&1")
-      return if installed
-      message = <<~EOL
-        ERROR: az is not installed. Please install the az command and configure it.
-        AzureInfo uses it to detect azure resource group, location, subscription id, and tenant id.
-
-        You can also configure these environment variables instead of installing the az cli.
-
-            ARM_CLIENT_ID
-            ARM_CLIENT_SECRET
-            ARM_SUBSCRIPTION_ID
-            ARM_TENANT_ID
-
-      EOL
-      if ENV['AZ_INFO_RAISE_ERROR']
-        raise Error.new(message)
-      else
-        puts message
-        exit 1
-      end
-    end
-  end
-end