Merge pull request #22 from rdytech/NEP-17834-setup-for-multi-env-configs

Nep 17834 setup for multi env configs

Author: jbat

.gitignore

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

CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Change Log
 
+## 0.1.5 - 2024-05-10
+
+* add multi config for multi env creds https://github.com/rdytech/superset-client/pull/22
+* add endpoint for sqllab/execute https://github.com/rdytech/superset-client/pull/22
+* add endpoint for database/list https://github.com/rdytech/superset-client/pull/22
+* add delete cascade endpoint by @jbat in https://github.com/rdytech/superset-client/pull/21
+
+## 0.1.4 - 2024-05-01
+
+* Filter dashboards by array of tags by @jbat in https://github.com/rdytech/superset-client/pull/20
+* adds endpoints for Delete of dashboards, charts, datasets @jbat in https://github.com/rdytech/superset-client/pull/20
+* adds endpoints for BulkDelete of dashboards, charts, datasets @jbat in https://github.com/rdytech/superset-client/pull/20
+
 ## 0.1.3 - 2024-04-23
 
 * duplicate dashboard should also create embedded setting by @jbat in https://github.com/rdytech/superset-client/pull/14

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

@@ -9,11 +9,14 @@ Create your own .env file with
 
 Adjust .env as required.
 ```
-ENV['SUPERSET_HOST'] = "https://your-superset-host.com"
-ENV['SUPERSET_API_USERNAME']="your-username"
-ENV['SUPERSET_API_PASSWORD']="your-password"
+SUPERSET_HOST="https://your-superset-host.com"
+SUPERSET_API_USERNAME="your-username"
+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://your-staging-superset-host.com/superset/dashboard/6/ |
++----+------------------+-----------+------------------------------------------------------------------+
+```
+
+
+
 

lib/superset/database/list.rb

@@ -0,0 +1,51 @@
+# Usage: Superset::Database::List.call
+# Usage: Superset::Dashboard::List.new(title_contains: 'test').list
+
+module Superset
+  module Database
+    class List < Superset::Request
+      attr_reader :title_contains
+
+      def initialize(page_num: 0, title_contains: '')
+        @title_contains = title_contains
+        super(page_num: page_num)
+      end
+
+      def self.call
+        self.new.list
+      end
+
+      def response
+        validate_constructor_args
+        super
+      end
+
+      def ids
+        result.map { |d| d[:id] }
+      end
+
+      private
+
+      def route
+        "database/?q=(#{query_params})"
+      end
+
+      def filters
+        # TODO filtering across all list classes can be refactored to support multiple options in a more flexible way
+        filter_set = []
+        filter_set << "(col:database_name,opr:ct,value:'#{title_contains}')" if title_contains.present?
+        unless filter_set.empty?
+          "filters:!(" + filter_set.join(',') + "),"
+        end
+      end
+
+      def list_attributes
+        [:id, :database_name, :backend, :expose_in_sqllab]
+      end
+
+      def validate_constructor_args
+        raise InvalidParameterError, "title_contains must be a String type" unless title_contains.is_a?(String)
+      end
+    end
+  end
+end

lib/superset/sqllab/execute.rb

@@ -0,0 +1,51 @@
+module Superset
+  module Sqllab
+    class Execute < Superset::Request
+      class InvalidParameterError < StandardError; end
+
+      attr_reader :database_id, :query, :schema
+
+      def initialize(database_id: , query: , schema: 'public')
+        @database_id = database_id
+        @query = query
+        @schema = schema
+      end
+
+      def perform
+        validate_constructor_args
+        response
+        data
+      end
+
+      def response
+        @response ||= client.post(route, query_params)
+      end
+
+      def data
+        response["data"]
+      end
+
+      private
+
+      def route
+        "sqllab/execute/"
+      end
+
+      def query_params
+        {
+          database_id: database_id,
+          sql:         query,
+          schema:      schema,
+          queryLimit:  1000,
+          runAsync: false,
+        }
+      end
+
+      def validate_constructor_args
+        raise InvalidParameterError, "database_id integer is required" unless database_id.present? && database_id.is_a?(Integer)
+        raise InvalidParameterError, "query string is required" unless query.present? && query.is_a?(String)
+        raise InvalidParameterError, "schema must be a String type" unless schema.is_a?(String)
+      end
+    end
+  end
+end

lib/superset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superset
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

spec/superset/dashboard/list_spec.rb

@@ -108,8 +108,5 @@
           "),page:3,page_size:100")
       end
     end
-
-
   end
-
 end

spec/superset/database/list_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Database::List do
+  subject { described_class.new }
+  let(:result) do
+    [
+      {
+        id: 1,
+        database_name: 'Test 1',
+        backend: 'postgres',
+        expose_in_sqllab: 'true'
+      },
+      {
+        id: 2,
+        database_name: 'Test 2',
+        backend: 'mysql',
+        expose_in_sqllab: 'false'
+      }
+    ]
+  end
+
+  before do
+    allow(subject).to receive(:result).and_return(result)
+  end
+
+  describe '#rows' do
+    specify do
+      expect(subject.rows).to match_array(
+        [
+          ['1', "Test 1", "postgres", "true"],
+          ['2', 'Test 2', 'mysql', "false"]
+        ]
+      )
+    end
+  end
+
+  describe '#query_params' do
+    context 'for pagination' do
+      context 'with defaults' do
+        specify do
+          expect(subject.query_params).to eq("page:0,page_size:100")
+        end
+      end
+
+      context 'with specifiec page' do
+        subject { described_class.new(page_num: 5) }
+
+        specify do
+          expect(subject.query_params).to eq("page:5,page_size:100")
+        end
+      end
+    end
+
+    context 'with title_contains filters' do
+      subject { described_class.new(title_contains: 'acme') }
+
+      specify do
+        expect(subject.query_params).to eq("filters:!((col:database_name,opr:ct,value:'acme')),page:0,page_size:100")
+      end
+    end
+  end
+end