Refactor to add helper utility for config

Author: yuanying

kubernetes/README.md

@@ -53,14 +53,10 @@ Please follow the [installation](#installation) procedure and then run the follo
 ```ruby
 # Load the gem
 require 'kubernetes'
+require 'kubernetes/utils'
 
-# Setup authorization
-Kubernetes.configure do |config|
-  # Configure API key authorization: BearerToken
-  config.api_key['authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['authorization'] = 'Bearer'
-end
+# Configs can be set in Configuration class directly or using helper utility
+Kubernetes.load_kube_config
 
 api_instance = Kubernetes::AdmissionregistrationApi.new
 

kubernetes/lib/kubernetes/config/incluster_config.rb

@@ -19,20 +19,6 @@ module Kubernetes
 
   class InClusterConfig
 
-    class << self
-
-      #
-      # Use the service account kubernetes gives to pods to connect to kubernetes
-      # cluster. It's intended for clients that expect to be running inside a pod
-      # running on kubernetes. It will raise an exception if called from a process
-      # not running in a kubernetes environment.
-      def load(client_configuration: Configuration.default)
-        config = self.new
-        config.configure(client_configuration)
-      end
-
-    end
-
     SERVICE_HOST_ENV_NAME = "KUBERNETES_SERVICE_HOST"
     SERVICE_PORT_ENV_NAME = "KUBERNETES_SERVICE_PORT"
     SERVICE_TOKEN_FILENAME = "/var/run/secrets/kubernetes.io/serviceaccount/token"

kubernetes/lib/kubernetes/config/kube_config.rb

@@ -29,39 +29,6 @@ class KubeConfig
 
     class << self
 
-      #
-      # Loads authentication and cluster information from kube-config file
-      # and stores them in Kubernetes::Configuration.
-      # @param config_file [String] Path of the kube-config file.
-      # @param context [String] Set the active context. If is set to nil, current_context from config file will be used.
-      # @param client_configuration [Kubernetes::Configuration] The Kubernetes::Configuration tp set configs to.
-      def load(
-        config_file=ENV['KUBE_CONFIG'],
-        context: nil,
-        client_configuration: Configuration.default
-      )
-        config_file ||= KUBE_CONFIG_DEFAULT_LOCATION
-        config = self.new(config_file)
-        config.configure(client_configuration, context)
-      end
-
-      #
-      # Loads configuration the same as load_kube_config but returns an ApiClient
-      # to be used with any API object. This will allow the caller to concurrently
-      # talk with multiple clusters.
-      # @param config_file [String] Path of the kube-config file.
-      # @param context [String] Set the active context. If is set to nil, current_context from config file will be used.
-      # @return [Kubernetes::ApiClient] Api client for Kubernetes cluster
-      def new_client(
-        config_file=ENV['KUBE_CONFIG'],
-        context: nil
-      )
-        config_file ||= KUBE_CONFIG_DEFAULT_LOCATION
-        client_configuration = Configuration.new
-        load(config_file, context: context, client_configuration: client_configuration)
-        ApiClient.new(client_configuration)
-      end
-
       def list_context_names(config_file=KUBE_CONFIG_DEFAULT_LOCATION)
         config = self.new(config_file)
         return config.list_context_names

kubernetes/lib/kubernetes/utils.rb

@@ -0,0 +1,64 @@
+# Copyright 2017 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'kubernetes/config/incluster_config'
+require 'kubernetes/config/kube_config'
+
+module Kubernetes
+
+  #
+  # Use the service account kubernetes gives to pods to connect to kubernetes
+  # cluster. It's intended for clients that expect to be running inside a pod
+  # running on kubernetes. It will raise an exception if called from a process
+  # not running in a kubernetes environment.
+  def load_incluster_config(client_configuration: Configuration.default)
+    config = InClusterConfig.new
+    config.configure(client_configuration)
+  end
+
+  #
+  # Loads authentication and cluster information from kube-config file
+  # and stores them in Kubernetes::Configuration.
+  # @param config_file [String] Path of the kube-config file.
+  # @param context [String] Set the active context. If is set to nil, current_context from config file will be used.
+  # @param client_configuration [Kubernetes::Configuration] The Kubernetes::Configuration tp set configs to.
+  def load_kube_config(
+    config_file=ENV['KUBECONFIG'],
+    context: nil,
+    client_configuration: Configuration.default
+  )
+    config_file ||= KubeConfig::KUBE_CONFIG_DEFAULT_LOCATION
+    config = KubeConfig.new(config_file)
+    config.configure(client_configuration, context)
+  end
+
+  #
+  # Loads configuration the same as load_kube_config but returns an ApiClient
+  # to be used with any API object. This will allow the caller to concurrently
+  # talk with multiple clusters.
+  # @param config_file [String] Path of the kube-config file.
+  # @param context [String] Set the active context. If is set to nil, current_context from config file will be used.
+  # @return [Kubernetes::ApiClient] Api client for Kubernetes cluster
+  def new_client_from_config(
+    config_file=ENV['KUBECONFIG'],
+    context: nil
+  )
+    config_file ||= KubeConfig::KUBE_CONFIG_DEFAULT_LOCATION
+    client_configuration = Configuration.new
+    load_kube_config(config_file, context: context, client_configuration: client_configuration)
+    ApiClient.new(client_configuration)
+  end
+
+  extend self
+end

kubernetes/spec/config/kube_config_spec.rb

@@ -15,156 +15,11 @@
 require 'base64'
 require 'spec_helper'
 require 'config/matchers'
+require 'fixtures/config/kube_config_hash'
 
 require 'kubernetes/config/kube_config'
 
 
-TEST_TOKEN_FILE = Kubernetes::Testing.file_fixture('tokens/token')
-
-TEST_DATA = "test-data"
-TEST_DATA_BASE64 = Base64.strict_encode64(TEST_DATA)
-
-TEST_HOST = "http://test-host"
-TEST_USERNAME = "me"
-TEST_PASSWORD = "pass"
-# token for me:pass
-TEST_BASIC_TOKEN = "Basic bWU6cGFzcw=="
-
-TEST_SSL_HOST = "https://test-host"
-TEST_CERTIFICATE_AUTH = "cert-auth"
-TEST_CERTIFICATE_AUTH_BASE64 = Base64.strict_encode64(TEST_CERTIFICATE_AUTH)
-TEST_CLIENT_KEY = "client-key"
-TEST_CLIENT_KEY_BASE64 = Base64.strict_encode64(TEST_CLIENT_KEY)
-TEST_CLIENT_CERT = "client-cert"
-TEST_CLIENT_CERT_BASE64 = Base64.strict_encode64(TEST_CLIENT_CERT)
-
-TEST_CONTEXT_DEFAULT = {
-  'name' => 'default',
-  'context' => {
-    'cluster' => 'default',
-    'user' => 'default',
-  }
-}
-TEST_CONTEXT_NO_USER = {
-  'name' => 'no_user',
-  'context' => {
-    'cluster' => 'default',
-  }
-}
-TEST_CONTEXT_SSL = {
-  'name' => 'context_ssl',
-  'context' => {
-    'cluster' => 'ssl-file',
-    'user' => 'user_cert_file',
-  }
-}
-TEST_CONTEXT_TOKEN = {
-  'name' => 'context_token',
-  'context' => {
-    'cluster' => 'ssl-file',
-    'user' => 'simple_token',
-  }
-}
-
-TEST_CLUSTER_DEFAULT = {
-  'name' => 'default',
-  'cluster' => {
-    'server' => TEST_HOST,
-  },
-}
-TEST_CLUSTER_SSL_FILE = {
-  'name' => 'ssl-file',
-  'cluster' => {
-    'server' => TEST_SSL_HOST,
-    'certificate-authority' => Kubernetes::Testing.file_fixture('certs/ca.crt').to_s,
-  },
-}
-TEST_CLUSTER_SSL_DATA = {
-  'name' => 'ssl-data',
-  'cluster' => {
-    'server' => TEST_SSL_HOST,
-    'certificate-authority-data' => TEST_CERTIFICATE_AUTH_BASE64,
-  },
-}
-TEST_CLUSTER_INSECURE = {
-  'name' => 'ssl-data-insecure',
-  'cluster' => {
-    'server' => TEST_SSL_HOST,
-    'certificate-authority-data' => TEST_CERTIFICATE_AUTH_BASE64,
-    'insecure-skip-tls-verify' => true,
-  },
-}
-
-TEST_USER_DEFAULT = {
-  'name' => 'default',
-  'user' => {
-    'token' => TEST_DATA_BASE64,
-  }
-}
-TEST_USER_SIMPLE_TOKEN = {
-  'name' => 'simple_token',
-  'user' => {
-    'token' => TEST_DATA_BASE64,
-    'username' => TEST_USERNAME,  # should be ignored
-    'password' => TEST_PASSWORD,  # should be ignored
-  },
-}
-TEST_USER_SIMPLE_TOKEN_FILE = {
-  'name' => 'simple_token_file',
-  'user' => {
-    'tokenFile' => TEST_TOKEN_FILE,
-    'username' => TEST_USERNAME,  # should be ignored
-    'password' => TEST_PASSWORD,  # should be ignored
-  },
-}
-TEST_USER_USER_PASS = {
-  'name' => 'user_pass',
-  'user' => {
-    'username' => TEST_USERNAME,  # should be ignored
-    'password' => TEST_PASSWORD,  # should be ignored
-  },
-}
-TEST_USER_CERT_DATA = {
-  'name' => 'user_cert_data',
-  'user' => {
-    'token' => TEST_DATA_BASE64,
-    'client-certificate-data' => TEST_CLIENT_CERT_BASE64,
-    'client-key-data' => TEST_CLIENT_KEY_BASE64,
-  },
-}
-TEST_USER_CERT_FILE = {
-  'name' => 'user_cert_file',
-  'user' => {
-    'client-certificate' => Kubernetes::Testing.file_fixture('certs/client.crt').to_s,
-    'client-key' => Kubernetes::Testing.file_fixture('certs/client.key').to_s,
-  },
-}
-
-TEST_KUBE_CONFIG = {
-  'current-context' => 'no_user',
-  'contexts' => [
-    TEST_CONTEXT_DEFAULT,
-    TEST_CONTEXT_NO_USER,
-    TEST_CONTEXT_SSL,
-    TEST_CONTEXT_TOKEN,
-  ],
-  'clusters' => [
-    TEST_CLUSTER_DEFAULT,
-    TEST_CLUSTER_SSL_FILE,
-    TEST_CLUSTER_SSL_DATA,
-    TEST_CLUSTER_INSECURE,
-  ],
-  'users' => [
-    TEST_USER_DEFAULT,
-    TEST_USER_SIMPLE_TOKEN,
-    TEST_USER_SIMPLE_TOKEN_FILE,
-    TEST_USER_USER_PASS,
-    TEST_USER_CERT_DATA,
-    TEST_USER_CERT_FILE,
-  ],
-}
-
-
 describe Kubernetes::KubeConfig do
   let(:kube_config) { Kubernetes::KubeConfig.new(file_fixture('config/config').to_s, TEST_KUBE_CONFIG) }