NEP-17834 setup config for multi env creds

Author: jbat

.gitignore

@@ -13,7 +13,7 @@
 superset-*.gem
 
 # ignore local .env variables
-.env
+.env*
 
 # ignore local log file
 log/superset-client.log

bin/console

@@ -18,4 +18,35 @@ Dir["./lib/**/*.rb"].each { |f| require f }
 
 require "pry"
 
+# if accessing multiple supeset host environments regularly you can optionally
+# setup multiple env files, see ./doc/setting_up_personal_api_credentials.md for more info
+if ENV['SUPERSET_ENVIRONMENT']
+  env_file = ".env-#{ENV['SUPERSET_ENVIRONMENT']}"
+  if File.exist?(env_file)
+    Dotenv.overload(env_file)
+    puts "ENV configuration loaded from from #{env_file}"
+  else
+    puts "Environment file #{env_file} not found"
+    exit
+  end
+end
+
+
+# Add the SUPERSET_ENVIRONMENT to the PRY prompt if it exists
+if ENV['SUPERSET_ENVIRONMENT']
+  Pry.config.prompt = Pry::Prompt.new('custom', 'Custom Pry prompt with suffix', [proc do |target_self, nest_level, pry|
+    "[#{pry.input_ring.size}] (#{":#{nest_level}" unless nest_level.zero?}ENV:#{ENV['SUPERSET_ENVIRONMENT'].upcase})> "
+  end,
+  proc do |target_self, nest_level, pry|
+    "[#{pry.input_ring.size}] (#{":#{nest_level}" unless nest_level.zero?}ENV:#{ENV['SUPERSET_ENVIRONMENT'].upcase})* "
+  end])
+end
+
+unless ENV['SUPERSET_HOST'] && ENV['SUPERSET_API_USERNAME'] && ENV['SUPERSET_API_PASSWORD']
+  puts "Missing environment variables.  Check your .env file"
+  puts "Please set each value for SUPERSET_HOST, SUPERSET_API_USERNAME, and SUPERSET_API_PASSWORD values"
+  puts "Refer to ./doc/setting_up_personal_api_credentials.md for more info"
+  exit
+end
+
 Pry.start(__FILE__)

doc/setting_up_personal_api_credentials.md

@@ -14,6 +14,9 @@ ENV['SUPERSET_API_USERNAME']="your-username"
 ENV['SUPERSET_API_PASSWORD']="your-password"
 ```
 
+If you have multiple superset hosts across various environments you also have the option
+to create individual env files per environment.  More details below.
+
 ## What is my user name?
 
 If your Superset instance is setup to authenicate via SSO then your authenticating agent will most likely have provided a username for you in the form of a UUID value.
@@ -57,6 +60,59 @@ Edit the params to only consist of only the password field and the value of your
 
 And click Execute.
 
-Create your `.env`
-Add your username and password to the `.env` file.
+Within your `.env` now add your username and password.
+
+# Accessing API across Multiple Environments
+
+Given some local development requirements where you have to access multiple superset hosts across various environments with different credentials you can setup the env creds as follows.
+
+Just set the overall superset environment in `.env`
+
+```
+# .env file holding one setting for the overall superset environment
+SUPERSET_ENVIRONMENT='staging'
+```
+
+Then create a new file called `.env-staging` that holds your superset staging host and credentials.
+
+```
+# specific settings for the superset staging host
+SUPERSET_HOST="https://your-staging-superset-host.com"
+SUPERSET_API_USERNAME="staging-user-here"
+SUPERSET_API_PASSWORD="set-password-here"
+```
+
+Do the same for production env.  
+Create a new file called `.env-production` that holds your superset production host and credentials.
+
+```
+# specific settings for the superset production host
+SUPERSET_HOST="https://your-production-superset-host.com"
+SUPERSET_API_USERNAME="production-user-here"
+SUPERSET_API_PASSWORD="set-password-here"
+```
+
+The command `bin/console` will then load your env file depending on the value in ENV['SUPERSET_ENVIRONMENT'] from the primary `.env`.
+
+When you need to switch envs, exit the console, edit the .env to your desired value, eg `production`, then open a console again.
+
+Bonus is the Pry prompt will now also include the `SUPERSET_ENVIRONMENT` value.
+
+```
+bin/console
+ENV configuration loaded from from .env-staging
+[1] (ENV:STAGING)> Superset::Dashboard::List.new(title_contains: 'video').list
+
+Happi: GET https://your-staging-superset-host.com/api/v1/dashboard/?q=(filters:!((col:dashboard_title,opr:ct,value:'video')),page:0,page_size:100), {}
++----+------------------+-----------+------------------------------------------------------------------+
+|                                      Superset::Dashboard::List                                       |
++----+------------------+-----------+------------------------------------------------------------------+
+| Id | Dashboard title  | Status    | Url                                                              |
++----+------------------+-----------+------------------------------------------------------------------+
+| 6  | Video Game Sales | published | https://staging.ready-superset.jobready.io/superset/dashboard/6/ |
++----+------------------+-----------+------------------------------------------------------------------+
+```
+
+
+