azure_info 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f54bada299a0f5e98838be7c05dab9de5d7c721f1a4934a1f08a2a94c9d15f2c
-  data.tar.gz: 7e946eddcb904a1f352e50a8f1a7ca709263dd4b9343eb25fae4150d18602b6f
+  metadata.gz: e4ae9c9490f68fe1f75f04f8c4ad05adb4c4c3ddbe4723563e33739723c13f64
+  data.tar.gz: f463b07527a94b6851fefa659e568a9d4d59c1d0496dd136e62067a8bdf8d4f3
 SHA512:
-  metadata.gz: 1e3f1049ebcae5a4ec412a1e65f9df3245cfcecd9704a3eaedf9eb75351f813ac3f8a2c9a672720ae24ff8d25cff94b80fd14e1017445c0aecd8b0ac5eead993
-  data.tar.gz: 1d49d741021fdda2b73a70544dda901f4856e1a0a613edbcd77f7cfa64f3ec7cc177bcf9e554ef94f8c88aef2b54f7c8a50d669337296b13d77feb8e05e90f0d
+  metadata.gz: 5ea982a5564f29622a740324a6459ea316f4b174ef6723e4e1859ea6f8ed759909a930dda066d3680989972d2358a721e3d2ab57c28c62db6c554fce155c4b57
+  data.tar.gz: a82b55909878ea8bf6a00db2829762fb6c0632c0ef9d59b336cd8c8bc6ffa087526a52aacca18a883ba416b742be8ebb8ed6c09ba754fde4997127e33cde865f

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+
+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
+
+## [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
+
+## [0.1.0]
+- Initial release.

data/README.md

@@ -1,6 +1,10 @@
 # AzureInfo
 
-Simple library to get current gcp data like subscription_id, tenant_id, group, and location.
+[![Gem Version](https://badge.fury.io/rb/azure_info.svg)](https://badge.fury.io/rb/azure_info)
+
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
+Simple library to get current Azure info like subscription_id, tenant_id, group, and location.
 
 ## Installation
 
@@ -31,12 +35,33 @@ 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=useast group=RESOURCE_GROUP
+    az configure --defaults location=eastus group=RESOURCE_GROUP
 
 ## Contributing
 

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
@@ -8,8 +8,38 @@ module AzureInfo
     def az_account_show
       return @az_account_show if @az_account_show
       check_az_installed!
-      out = `az account show --output json`.strip
+
+      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)
     end
+
+    def raise_status_error(command)
+      message =<<~EOL
+        ERROR: error running '#{command}'.
+        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
+
+        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)
+    end
+
+    def raise_empty_error(command)
+      message =<<~EOL
+        The '#{command}' return a blank string.
+        Something went wrong. Try running it manually and confirm it returns json.
+      EOL
+      raise Error.new(message)
+    end
   end
 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_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_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 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.0"
+  VERSION = "0.1.4"
 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") || "useast"
+    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.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -28,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
@@ -51,7 +51,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,

data/lib/azure_info/base.rb

@@ -1,9 +0,0 @@
-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.")
-    end
-  end
-end