clean up and add testcases for less sensitive config loader

src/KubernetesClientConfiguration.ConfigFile.cs

@@ -51,12 +51,25 @@ namespace k8s
 
             var k8SConfig = LoadKubeConfig(kubeconfig);
             var k8SConfiguration = new KubernetesClientConfiguration();
-            k8SConfiguration.Initialize(k8SConfig, currentContext);
+
+            currentContext = currentContext ?? k8SConfig.CurrentContext;
+
+            // only init context if context if set
+            if (currentContext != null)
+            {
+                k8SConfiguration.InitializeContext(k8SConfig, currentContext);
+            }
 
             if (!string.IsNullOrWhiteSpace(masterUrl))
             {
                 k8SConfiguration.Host = masterUrl;
             }
+
+            if (string.IsNullOrWhiteSpace(k8SConfiguration.Host))
+            {
+                throw new KubeConfigException("Cannot infer server host url either from context or masterUrl");
+            }
+
             return k8SConfiguration;
         }
 
@@ -65,11 +78,9 @@ namespace k8s
         /// </summary>
         /// <param name="k8SConfig">Kubernetes Configuration</param>
         /// <param name="currentContext">Current Context</param>
-        private void Initialize(K8SConfiguration k8SConfig, string currentContext = null)
+        private void InitializeContext(K8SConfiguration k8SConfig, string currentContext)
         {
             // current context
-            currentContext = currentContext ?? k8SConfig.CurrentContext;
-
             var activeContext =
                 k8SConfig.Contexts.FirstOrDefault(
                     c => c.Name.Equals(currentContext, StringComparison.OrdinalIgnoreCase));

tests/KubernetesClientConfigurationTests.cs

@@ -1,82 +1,11 @@
-using Xunit;
 using System.IO;
+using k8s.Exceptions;
+using Xunit;
 
 namespace k8s.Tests
 {
     public class KubernetesClientConfigurationTests
     {
-
-        public static string readLine(string fileName)
-        {
-            StreamReader reader = new StreamReader(new FileStream(fileName, FileMode.Open, FileAccess.Read));
-            return reader.ReadLine();
-        }
-
-        /// <summary>
-        /// This file contains a sample kubeconfig file
-        /// </summary>
-        private static readonly string kubeConfigFileName = "assets/kubeconfig.yml";
-
-        /// <summary>
-        /// Invalid test file with no context on purpose
-        /// </summary>
-        private static readonly string kubeConfigNoContexts = "assets/kubeconfig-no-context.yml";
-
-        /// <summary>
-        /// Sample configuration file with user/password authentication
-        /// </summary>
-        private static readonly string kubeConfigUserPassword = "assets/kubeconfig.user-pass.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect user credentials structures on purpose
-        /// </summary>
-        private static readonly string kubeConfigNoCredentials = "assets/kubeconfig.no-credentials.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect cluster/server structure on purpose
-        /// </summary>
-        private static readonly string kubeConfigNoServer = "assets/kubeconfig.no-server.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect cluster/server structure on purpose
-        /// </summary>
-        private static readonly string kubeConfigNoCluster = "assets/kubeconfig.no-cluster.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect match in cluster name
-        /// </summary>
-        private static readonly string kubeConfigClusterMissmatch = "assets/kubeconfig.cluster-missmatch.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect TLS configuration in cluster section
-        /// </summary>
-        private static readonly string kubeConfigTlsNoSkipError = "assets/kubeconfig.tls-no-skip-error.yml";
-
-        /// <summary>
-        /// Sample configuration file with incorrect TLS configuration in cluster section
-        /// </summary>
-        private static readonly string kubeConfigTlsSkip = "assets/kubeconfig.tls-skip.yml";
-
-        /// <summary>
-        /// The configuration file is not present. An KubeConfigException should be thrown
-        /// </summary>
-        [Fact]
-        public void ConfigurationFileNotFound()
-        {
-            var fi = new FileInfo("/path/to/nowhere");
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
-        }
-
-        /// <summary>
-        /// Checks Host is loaded from the default configuration file
-        /// </summary>
-        [Fact]
-        public void DefaultConfigurationLoaded()
-        {
-            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(new FileInfo(kubeConfigFileName));
-            Assert.NotNull(cfg.Host);
-        }
-
         /// <summary>
         ///     Check if host is properly loaded, per context
         /// </summary>
@@ -85,7 +14,7 @@ namespace k8s.Tests
         [InlineData("queen-anne-context", "https://pig.org:443")]
         public void ContextHost(string context, string host)
         {
-            var fi = new FileInfo(kubeConfigFileName);
+            var fi = new FileInfo("assets/kubeconfig.yml");
             var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, context);
             Assert.Equal(host, cfg.Host);
         }
@@ -99,7 +28,7 @@ namespace k8s.Tests
         [InlineData("queen-anne-context", "black-token")]
         public void ContextUserToken(string context, string token)
         {
-            var fi = new FileInfo(kubeConfigFileName);
+            var fi = new FileInfo("assets/kubeconfig.yml");
             var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, context);
             Assert.Equal(context, cfg.CurrentContext);
             Assert.Null(cfg.Username);
@@ -110,13 +39,13 @@ namespace k8s.Tests
         ///     Checks if certificate-based authentication is loaded properly from the config file, per context
         /// </summary>
         /// <param name="context">Context to retreive the configuration</param>
-        /// <param name="clientCertData">'client-certificate-data' node content</param>
+        /// <param name="clientCert">'client-certificate-data' node content</param>
         /// <param name="clientCertKey">'client-key-data' content</param>
         [Theory]
         [InlineData("federal-context", "assets/client.crt", "assets/client.key")]
-        public void ContextCertificateTest(string context, string clientCert, string clientCertKey)
+        public void ContextCertificate(string context, string clientCert, string clientCertKey)
         {
-            var fi = new FileInfo(kubeConfigFileName);
+            var fi = new FileInfo("assets/kubeconfig.yml");
             var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, context);
             Assert.Equal(context, cfg.CurrentContext);
             Assert.Equal(cfg.ClientCertificateFilePath, clientCert);
@@ -131,85 +60,37 @@ namespace k8s.Tests
         [InlineData("victorian-context")]
         public void ClientData(string context)
         {
-            var fi = new FileInfo(kubeConfigFileName);
+            var fi = new FileInfo("assets/kubeconfig.yml");
             var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, context);
             Assert.Equal(context, cfg.CurrentContext);
             Assert.NotNull(cfg.SslCaCert);
-            Assert.Equal(readLine("assets/client-certificate-data.txt"), cfg.ClientCertificateData);
-            Assert.Equal(readLine("assets/client-key-data.txt"), cfg.ClientCertificateKeyData);
-        }
-
-
-        /// <summary>
-        /// Test that an Exception is thrown when initializating a KubernetClientConfiguration whose config file Context is not present
-        /// </summary>
-        [Fact]
-        public void ContextNotFound()
-        {
-            var fi = new FileInfo(kubeConfigFileName);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, "context-not-found"));
+            Assert.Equal(File.ReadAllText("assets/client-certificate-data.txt"), cfg.ClientCertificateData);
+            Assert.Equal(File.ReadAllText("assets/client-key-data.txt"), cfg.ClientCertificateKeyData);
         }
 
         /// <summary>
-        /// Test if KubeConfigException is thrown when no Contexts and we use the default context name
+        ///     Checks that a KubeConfigException is thrown when no certificate-authority-data is set and user do not require tls
+        ///     skip
         /// </summary>
         [Fact]
-        public void NoContexts()
+        public void CheckClusterTlsCorrectness()
         {
-            var fi = new FileInfo(kubeConfigNoContexts);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+            var fi = new FileInfo("assets/kubeconfig.tls-no-skip-error.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
         }
 
         /// <summary>
-        /// Test if KubeConfigException is thrown when no Contexts are set and we specify a concrete context name
+        ///     Checks that a KubeConfigException is thrown when no certificate-authority-data is set and user do not require tls
+        ///     skip
         /// </summary>
         [Fact]
-        public void NoContextsExplicit()
+        public void CheckClusterTlsSkipCorrectness()
         {
-            var fi = new FileInfo(kubeConfigNoContexts);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, "context"));
-        }
-
-        /// <summary>
-        /// Checks user/password authentication information is read properly
-        /// </summary>
-        [Fact]
-        public void UserPasswordAuthentication()
-        {
-            var fi = new FileInfo(kubeConfigUserPassword);
+            var fi = new FileInfo("assets/kubeconfig.tls-skip.yml");
             var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi);
-            Assert.Equal("admin", cfg.Username);
-            Assert.Equal("secret", cfg.Password);
-        }
-
-        /// <summary>
-        /// Checks that a KubeConfigException is thrown when incomplete user credentials
-        /// </summary>
-        [Fact]
-        public void IncompleteUserCredentials()
-        {
-            var fi = new FileInfo(kubeConfigNoCredentials);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
-        }
-
-        /// <summary>
-        /// Checks that a KubeConfigException is thrown when the server property is not set in cluster
-        /// </summary>
-        [Fact]
-        public void ServerNotFound()
-        {
-            var fi = new FileInfo(kubeConfigNoServer);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
-        }
-
-        /// <summary>
-        /// Checks that a KubeConfigException is thrown when the clusters section is missing
-        /// </summary>
-        [Fact]
-        public void ClusterNotFound()
-        {
-            var fi = new FileInfo(kubeConfigNoCluster);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+            Assert.NotNull(cfg.Host);
+            Assert.Null(cfg.SslCaCert);
+            Assert.True(cfg.SkipTlsVerify);
         }
 
         /// <summary>
@@ -218,44 +99,165 @@ namespace k8s.Tests
         [Fact]
         public void ClusterNameMissmatch()
         {
-            var fi = new FileInfo(kubeConfigClusterMissmatch);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+            var fi = new FileInfo("assets/kubeconfig.cluster-missmatch.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
         }
 
         /// <summary>
-        /// Checks that a KubeConfigException is thrown when no certificate-authority-data is set and user do not require tls skip 
+        ///     Checks that a KubeConfigException is thrown when the clusters section is missing
         /// </summary>
         [Fact]
-        public void CheckClusterTlsCorrectness()
+        public void ClusterNotFound()
         {
-            var fi = new FileInfo(kubeConfigTlsNoSkipError);
-            Assert.Throws<k8s.Exceptions.KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+            var fi = new FileInfo("assets/kubeconfig.no-cluster.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
         }
 
         /// <summary>
-        /// Checks that a KubeConfigException is thrown when no certificate-authority-data is set and user do not require tls skip 
+        ///     The configuration file is not present. An KubeConfigException should be thrown
         /// </summary>
         [Fact]
-        public void CheckClusterTlsSkipCorrectness()
+        public void ConfigurationFileNotFound()
         {
-            var fi = new FileInfo(kubeConfigTlsSkip);
-            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi);
+            var fi = new FileInfo("/path/to/nowhere");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+        }
+
+
+        /// <summary>
+        ///     Test that an Exception is thrown when initializating a KubernetClientConfiguration whose config file Context is not
+        ///     present
+        /// </summary>
+        [Fact]
+        public void ContextNotFound()
+        {
+            var fi = new FileInfo("assets/kubeconfig.yml");
+            Assert.Throws<KubeConfigException>(() =>
+                KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, "context-not-found"));
+        }
+
+        /// <summary>
+        ///     Checks Host is loaded from the default configuration file
+        /// </summary>
+        [Fact]
+        public void DefaultConfigurationLoaded()
+        {
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(new FileInfo("assets/kubeconfig.yml"));
             Assert.NotNull(cfg.Host);
-            Assert.Null(cfg.SslCaCert);
-            Assert.True(cfg.SkipTlsVerify);
         }
 
-        // /// <summary>
-        // /// Checks if the are pods
-        // /// </summary>
-        // [Fact]
-        // public void ListDefaultNamespacedPod()
-        // {
-        //     var k8sClientConfig = KubernetesClientConfiguration.BuildConfigFromConfigFile();
-        //     IKubernetes client = new Kubernetes(k8sClientConfig);
-        //     var listTask = client.ListNamespacedPodWithHttpMessagesAsync("default").Result;
-        //     var list = listTask.Body;
-        //     Assert.NotEqual(0, list.Items.Count);            
-        // }        
+        /// <summary>
+        ///     Checks that a KubeConfigException is thrown when incomplete user credentials
+        /// </summary>
+        [Fact]
+        public void IncompleteUserCredentials()
+        {
+            var fi = new FileInfo("assets/kubeconfig.no-credentials.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+        }
+
+        /// <summary>
+        ///     Test if KubeConfigException is thrown when no Contexts and we use the default context name
+        /// </summary>
+        [Fact]
+        public void NoContexts()
+        {
+            var fi = new FileInfo("assets/kubeconfig.no-context.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+        }
+
+        /// <summary>
+        ///     Test if KubeConfigException is thrown when no Contexts are set and we specify a concrete context name
+        /// </summary>
+        [Fact]
+        public void NoContextsExplicit()
+        {
+            var fi = new FileInfo("assets/kubeconfig-no-context.yml");
+            Assert.Throws<KubeConfigException>(() =>
+                KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, "context"));
+        }
+
+        /// <summary>
+        ///     Checks that a KubeConfigException is thrown when the server property is not set in cluster
+        /// </summary>
+        [Fact]
+        public void ServerNotFound()
+        {
+            var fi = new FileInfo("assets/kubeconfig.no-server.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+        }
+
+        /// <summary>
+        ///     Checks user/password authentication information is read properly
+        /// </summary>
+        [Fact]
+        public void UserPasswordAuthentication()
+        {
+            var fi = new FileInfo("assets/kubeconfig.user-pass.yml");
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi);
+            Assert.Equal("admin", cfg.Username);
+            Assert.Equal("secret", cfg.Password);
+        }
+
+        /// <summary>
+        ///     Checks that a KubeConfigException is thrown when user cannot be found in users
+        /// </summary>
+        [Fact]
+        public void UserNotFound()
+        {
+            var fi = new FileInfo("assets/kubeconfig.user-not-found.yml");
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+        }
+
+        /// <summary>
+        ///     Make sure that user is not a necessary field. set #issue 24
+        /// </summary>
+        [Fact]
+        public void EmptyUserNotFound()
+        {
+            var fi = new FileInfo("assets/kubeconfig.no-user.yml");
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi);
+
+            Assert.NotEmpty(cfg.Host);
+        }
+
+        /// <summary>
+        ///     Make sure Host is replaced by masterUrl
+        /// </summary>
+        [Fact]
+        public void OverrideByMasterUrl()
+        {
+            var fi = new FileInfo("assets/kubeconfig.yml");
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, masterUrl: "http://test.server");
+            Assert.Equal("http://test.server", cfg.Host);
+        }
+
+        /// <summary>
+        ///     Make sure that http urls are loaded even if insecure-skip-tls-verify === true
+        /// </summary>
+        [Fact]
+        public void SmartSkipTlsVerify()
+        {
+            var fi = new FileInfo("assets/kubeconfig.tls-skip-http.yml");
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi);
+            Assert.False(cfg.SkipTlsVerify);
+            Assert.Equal("http://horse.org", cfg.Host);
+        }
+
+        /// <summary>
+        ///     Checks config could work well when current-context is not set but masterUrl is set. #issue 24
+        /// </summary>
+        [Fact]
+        public void NoCurrentContext()
+        {
+            var fi = new FileInfo("assets/kubeconfig.no-current-context.yml");
+
+            // failed if cannot infer any server host
+            Assert.Throws<KubeConfigException>(() => KubernetesClientConfiguration.BuildConfigFromConfigFile(fi));
+
+            // survive when masterUrl is set
+            var cfg = KubernetesClientConfiguration.BuildConfigFromConfigFile(fi, masterUrl: "http://test.server");
+            Assert.Equal("http://test.server", cfg.Host);
+        }
     }
 }

tests/assets/kubeconfig.no-current-context.yml

@@ -0,0 +1,19 @@
+---
+apiVersion: v1
+clusters:
+- cluster:
+    certificate-authority: assets/ca.crt
+    server: https://horse.org:4443
+  name: horse-cluster
+contexts:
+- context:
+    cluster: horse-cluster
+    namespace: chisel-ns
+    user: green-user
+  name: federal-context
+kind: Config
+users:
+- name: green-user
+  user:
+    password: secret
+    username: admin

tests/assets/kubeconfig.no-user.yml

@@ -0,0 +1,14 @@
+---
+current-context: federal-context
+apiVersion: v1
+clusters:
+- cluster:
+    certificate-authority: assets/ca.crt
+    server: https://horse.org:4443
+  name: horse-cluster
+contexts:
+- context:
+    cluster: horse-cluster
+    namespace: chisel-ns
+  name: federal-context
+kind: Config

tests/assets/kubeconfig.tls-skip-http.yml

@@ -0,0 +1,19 @@
+---
+current-context: federal-context
+apiVersion: v1
+clusters:
+- cluster:
+    server: http://horse.org
+  name: horse-cluster
+contexts:
+- context:
+    cluster: horse-cluster
+    namespace: chisel-ns
+    user: green-user
+  name: federal-context
+kind: Config
+users:
+- name: green-user
+  user:
+    password: secret
+    username: admin

tests/assets/kubeconfig.user-not-found.yml

@@ -0,0 +1,15 @@
+---
+current-context: federal-context
+apiVersion: v1
+clusters:
+- cluster:
+    certificate-authority: assets/ca.crt
+    server: https://horse.org:4443
+  name: horse-cluster
+contexts:
+- context:
+    cluster: horse-cluster
+    namespace: chisel-ns
+    user: green-user
+  name: federal-context
+kind: Config