azure_info 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4ae9c9490f68fe1f75f04f8c4ad05adb4c4c3ddbe4723563e33739723c13f64
-  data.tar.gz: f463b07527a94b6851fefa659e568a9d4d59c1d0496dd136e62067a8bdf8d4f3
+  metadata.gz: 737b4ad017cbfce9e30a1d2eb1ca407c83b6c11197c676e9ec749b6d070ccea0
+  data.tar.gz: f698f4d4cd5a08eb51e16a64009289d3be5a49aa1712c3b480736ffc0c51bf83
 SHA512:
-  metadata.gz: 5ea982a5564f29622a740324a6459ea316f4b174ef6723e4e1859ea6f8ed759909a930dda066d3680989972d2358a721e3d2ab57c28c62db6c554fce155c4b57
-  data.tar.gz: a82b55909878ea8bf6a00db2829762fb6c0632c0ef9d59b336cd8c8bc6ffa087526a52aacca18a883ba416b742be8ebb8ed6c09ba754fde4997127e33cde865f
+  metadata.gz: 44d63cfc5298e5ddb81c1811231baa1c6285acfc23ee4f6a923166bac07e8c91c82c00a0ffedf63c21e26cffb9f2a89c5a4fa4713db63f6bc5acb88c2cdaf08a
+  data.tar.gz: 73c4d6bac182e50c17582d0446555a947889f4a12826959674d8c0fcb2d5d63b68da1e0d76e46bca80c94a500e606e9e03f0faf8e1a9e3f1d66f859439b4f715

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.5] - 2021-12-27
+- [#5](https://github.com/boltops-tools/azure_info/pull/5) improve error message when az cli not installed
+
 ## [0.1.4] - 2021-12-27
 - [#4](https://github.com/boltops-tools/azure_info/pull/4) improve error message when az cli not installed
 

data/lib/azure_info/account.rb

@@ -1,5 +1,5 @@
 module AzureInfo
-  class Account
+  class Account < Base
     def get(name)
       az_account_show[name]
     end
@@ -7,15 +7,22 @@ module AzureInfo
     # looks like az configure stores settings in  ~/.azure/config
     def az_account_show
       return @az_account_show if @az_account_show
-      check_az_installed!
 
-      command = "az account show --output json"
-      out = `#{command}`.strip
-
-      raise_status_error(command) unless $?.success?
-      raise_empty_error(command) if out.strip == ""
-
-      @az_account_show = JSON.load(out)
+      if az_installed?
+        command = "az account show --output json"
+        out = `#{command}`.strip
+
+        raise_status_error(command) unless $?.success?
+        raise_empty_error(command) if out.strip == ""
+
+        @az_account_show = JSON.load(out)
+      else
+        if env_vars_set?
+          {}
+        else
+          error_message
+        end
+      end
     end
 
     def raise_status_error(command)
@@ -24,14 +31,11 @@ module AzureInfo
         Maybe you havent ran `az login` or configured ~/.azure manually.
         You can configure az login non-interactively with
 
-            az login --service-principal \
-              --username USERNAME \
-              --password PASSWORD \
-              --tenant TENANT
+            az login --service-principal --username USERNAME --password PASSWORD --tenant TENANT
 
         Per https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli?view=azure-cli-latest#sign-in-using-a-service-principal
       EOL
-      raise Error.new(message)
+      error_message(message)
     end
 
     def raise_empty_error(command)
@@ -39,7 +43,7 @@ module AzureInfo
         The '#{command}' return a blank string.
         Something went wrong. Try running it manually and confirm it returns json.
       EOL
-      raise Error.new(message)
+      error_message(message)
     end
   end
 end

data/lib/azure_info/base.rb

@@ -0,0 +1,54 @@
+module AzureInfo
+  class Base
+    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
+        ARM_ACCOUNT
+      ]
+    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: 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
+      show_error(message)
+    end
+
+    def show_error(message)
+      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/configure.rb

@@ -3,9 +3,9 @@
 #     az configure --defaults location=westus2 group=MyResourceGroup
 #
 module AzureInfo
-  class Configure
+  class Configure < Base
     def get(name)
-      item = azure_configs.find do |i|
+      item = az_configure.find do |i|
         i["name"] == name
       end
       item["value"] if item
@@ -13,11 +13,11 @@ module AzureInfo
 
   private
     # looks like az configure stores settings in  ~/.azure/config
-    def azure_configs
+    def az_configure
       if az_installed?
-        return @azure_configs if @azure_configs
+        return @az_configure if @az_configure
         out = `az configure --list-defaults --output json`.strip
-        @azure_configs = JSON.load(out)
+        @az_configure = JSON.load(out)
       else
         if env_vars_set?
           []
@@ -26,51 +26,5 @@ module AzureInfo
         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.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure_info
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tung Nguyen
@@ -29,6 +29,7 @@ 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