azure_info 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08572df2ac88f55e30953102b474fdc5bf73335d969a07a1648eeea184292fce'
-  data.tar.gz: 906aba07a7070e7723ff509d29dfd31326111d57b2b17f6eec959fe3212c384d
+  metadata.gz: 737b4ad017cbfce9e30a1d2eb1ca407c83b6c11197c676e9ec749b6d070ccea0
+  data.tar.gz: f698f4d4cd5a08eb51e16a64009289d3be5a49aa1712c3b480736ffc0c51bf83
 SHA512:
-  metadata.gz: d3a57a19786c6b412838cd6426ce4d30f1ea2e7406947d991c5607b1356e2d9836711ac2f78f8b2fa0591d5eaa18535caaaffb0ff5199d530d1714fc6c1848b4
-  data.tar.gz: b8cf86bf3740b9b08c964d36b9628f9cd23537fb6e67b689148e259b1e3d91534886e3ac2d5f9264ce97ca9e484fde3d7a9afb6c0b8d50a4c71aa6682622d0ff
+  metadata.gz: 44d63cfc5298e5ddb81c1811231baa1c6285acfc23ee4f6a923166bac07e8c91c82c00a0ffedf63c21e26cffb9f2a89c5a4fa4713db63f6bc5acb88c2cdaf08a
+  data.tar.gz: 73c4d6bac182e50c17582d0446555a947889f4a12826959674d8c0fcb2d5d63b68da1e0d76e46bca80c94a500e606e9e03f0faf8e1a9e3f1d66f859439b4f715

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 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
+
+## [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
+
+## [0.1.2] - 2021-04-15
+- [#2](https://github.com/boltops-tools/azure_info/pull/2) consider env vars also
+
 ## [0.1.1]
 - fix default location
 - provide friendly error message when az not returning json

data/README.md

@@ -35,11 +35,32 @@ AzureInfo.tenant_id
 
 This tool calls out to the az CLI. So the az CLI is required.
 
-## Setting the Defaults with az
+## Precedence
+
+This library will return values using different sources with this precedence:
+
+1. Environment variables: ARM_GROUP, ARM_LOCATION, ARM_SUBSCRIPTION_ID, ARM_TENANT_ID
+2. az cli: Usually configured in the `~/.azure/config`. Use `az configure --list-defaults` to double check.
+3. Defaults: A default is set for `location=eastus`. The other values must be configured.
+
+The config file used by the `az` command looks something like this:
+
+~/.azure/config
+
+    [cloud]
+    name = AzureCloud
+
+    [defaults]
+    location = eastus
+
+This command is also useful:
+
+    az account show
+
+## Setting the Defaults with az cli
 
     az login --username EMAIL_ADDRESS -t TENANT_ID
     az account set --subscription SUBSCRIPTION_ID
-
     az configure --defaults location=eastus group=RESOURCE_GROUP
 
 ## Contributing

data/lib/azure_info/account.rb

@@ -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

@@ -1,9 +1,54 @@
 module AzureInfo
   class Base
-    def check_az_installed!
-      installed = system("type az > /dev/null 2>&1")
-      return if installed
-      raise Error.new("ERROR: az is not installed. Please install the az command.")
+    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

@@ -5,18 +5,26 @@
 module AzureInfo
   class Configure < Base
     def get(name)
-      item = az_configure_defaults.find do |i|
+      item = az_configure.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_defaults
-      return @az_configure_defaults if @az_configure_defaults
-      check_az_installed!
-      out = `az configure --list-defaults --output json`.strip
-      @az_configure_defaults = JSON.load(out)
+    def az_configure
+      if az_installed?
+        return @az_configure if @az_configure
+        out = `az configure --list-defaults --output json`.strip
+        @az_configure = JSON.load(out)
+      else
+        if env_vars_set?
+          []
+        else
+          error_message
+        end
+      end
     end
   end
 end

data/lib/azure_info/version.rb

@@ -1,3 +1,3 @@
 module AzureInfo
-  VERSION = "0.1.1"
+  VERSION = "0.1.5"
 end

data/lib/azure_info.rb

@@ -8,29 +8,31 @@ module AzureInfo
   class Error < StandardError; end
 
   def group
-    configure.get("group")
+    ENV['ARM_GROUP'] || configure.get("group")
   end
   alias_method :group_id, :group
 
   def location
-    configure.get("location") || "eastus"
+    ENV['ARM_LOCATION'] || configure.get("location") || "eastus"
   end
 
   def subscription_id
-    account.get("id")
+    ENV['ARM_SUBSCRIPTION_ID'] || account.get("id")
   end
   alias_method :subscription, :subscription_id
 
   def tenant_id
-    account.get("tenantId")
+    ENV['ARM_TENANT_ID'] || account.get("tenantId")
   end
   alias_method :tenant, :tenant_id
 
 private
+  # info: group (resource group), location
   def configure
     @configure ||= Configure.new
   end
 
+  # info: id (subscription id), name (subscription name), tenantId
   def account
     @account ||= Account.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure_info
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -52,7 +52,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: 'Azure info: Simple library to get current subscription, resource group,