Add style linting with rubocop

Author: brendandburns

.travis.yml

@@ -1,4 +1,8 @@
 gemfile: kubernetes/Gemfile
 rvm:
   - 2.6
-script: sh -c 'cd kubernetes && bundle exec rspec'
+
+script:
+- cd kubernetes
+- bundle exec rubocop ./src
+- bundle exec rspec

kubernetes/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :development, :test do
   gem 'rake', '~> 12.0.0'
+  gem 'rubocop', '~> 0.65.0'
 end

kubernetes/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
     ZenTest (4.11.2)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-fsevent (0.2.14)
@@ -24,8 +25,15 @@ GEM
       ffi (>= 1.3.0)
     ffi (1.10.0)
     hashdiff (0.3.8)
+    jaro_winkler (1.5.2)
     json (2.1.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
     public_suffix (3.0.3)
+    rainbow (3.0.0)
     rake (12.0.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -40,11 +48,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
     sys-uname (1.0.4)
       ffi (>= 1.0.0)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
+    unicode-display_width (1.4.1)
     vcr (3.0.3)
     webmock (1.24.6)
       addressable (>= 2.3.6)
@@ -62,6 +81,9 @@ DEPENDENCIES
   kubernetes!
   rake (~> 12.0.0)
   rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.65.0)
   vcr (~> 3.0, >= 3.0.1)
   webmock (~> 1.24, >= 1.24.3)
 
+BUNDLED WITH
+   1.16.1

kubernetes/spec/config/kube_config_spec.rb

@@ -222,43 +222,17 @@
     end
   end
 
-  context '#create_temp_file_with_base64content' do
-    context 'when it is called at first time' do
-      it 'should return temp file path' do
-        expected_path = 'tempfile-path'
-        content = TEST_DATA_BASE64
-        io = double('io')
-        expect(io).to receive(:path).and_return(expected_path)
-        expect(io).to receive(:write).with(TEST_DATA)
-        allow(Tempfile).to receive(:open).and_yield(io)
-
-        expect(kube_config.send(:create_temp_file_with_base64content, content)).to eq(expected_path)
-      end
-    end
-
-    context 'when it is already called' do
-      it 'should return cached value' do
-        expected_path = 'tempfile-path'
-        content = TEST_DATA_BASE64
-        Kubernetes::KubeConfig.class_eval { class_variable_get(:@@temp_files)[content] = expected_path}
-        io = double('io')
-        expect(io).not_to receive(:path)
-        expect(io).not_to receive(:write).with(TEST_DATA)
 
-        expect(kube_config.send(:create_temp_file_with_base64content, content)).to eq(expected_path)
-      end
-    end
-
-    context 'load from defaults' do
-      before(:each) do
-        # Clear out everything before each run.
-        ENV['HOME'] = nil
-        ENV['KUBECONFIG'] = nil
-        ENV['KUBERNETES_SERVICE_HOST'] = nil
-        ENV['KUBERNETES_SERVICE_PORT'] = nil
+  context 'load from defaults' do
+    before(:each) do
+      # Clear out everything before each run.
+      ENV['HOME'] = nil
+      ENV['KUBECONFIG'] = nil
+      ENV['KUBERNETES_SERVICE_HOST'] = nil
+      ENV['KUBERNETES_SERVICE_PORT'] = nil
 
-        # Suppress warnings
-        warn_level = $VERBOSE
+      # Suppress warnings
+      warn_level = $VERBOSE
         $VERBOSE = nil
         Kubernetes::InClusterConfig::SERVICE_TOKEN_FILENAME = '/non/existent/file/token'
         Kubernetes::InClusterConfig::SERVICE_CA_CERT_FILENAME = '/non/existent/file/ca.crt'
@@ -304,5 +278,4 @@
         expect(config.host).to eq('localhost:8080')
       end
     end
-  end
 end

kubernetes/spec/utils_spec.rb

@@ -72,4 +72,32 @@
       expect(actual).to be_same_configuration_as(expected)
     end
   end
+
+  context '#create_temp_file_with_base64content' do
+    context 'when it is called at first time' do
+      it 'should return temp file path' do
+        expected_path = 'tempfile-path'
+        content = TEST_DATA_BASE64
+        io = double('io')
+        expect(io).to receive(:path).and_return(expected_path)
+        expect(io).to receive(:write).with(TEST_DATA)
+        allow(Tempfile).to receive(:open).and_yield(io)
+
+        expect(Kubernetes.create_temp_file_with_base64content(content)).to eq(expected_path)
+      end
+    end
+
+    context 'when it is already called' do
+      it 'should return cached value' do
+        expected_path = 'tempfile-path'
+        content = TEST_DATA_BASE64
+        Kubernetes::cache_temp_file(content, expected_path)
+        io = double('io')
+        expect(io).not_to receive(:path)
+        expect(io).not_to receive(:write).with(TEST_DATA)
+
+        expect(Kubernetes.create_temp_file_with_base64content(content)).to eq(expected_path)
+      end
+    end
+  end
 end

kubernetes/src/kubernetes/config/incluster_config.rb

@@ -16,28 +16,35 @@
 require 'kubernetes/config/error'
 
 module Kubernetes
-
+  # The InClusterConfig class represents configuration for authn/authz in a
+  # Kubernetes cluster.
   class InClusterConfig
-
-    SERVICE_HOST_ENV_NAME = "KUBERNETES_SERVICE_HOST"
-    SERVICE_PORT_ENV_NAME = "KUBERNETES_SERVICE_PORT"
-    SERVICE_TOKEN_FILENAME = "/var/run/secrets/kubernetes.io/serviceaccount/token"
-    SERVICE_CA_CERT_FILENAME = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+    # rubocop:disable LineLength
+    SERVICE_HOST_ENV_NAME = 'KUBERNETES_SERVICE_HOST'.freeze
+    SERVICE_PORT_ENV_NAME = 'KUBERNETES_SERVICE_PORT'.freeze
+    SERVICE_TOKEN_FILENAME = '/var/run/secrets/kubernetes.io/serviceaccount/token'.freeze
+    SERVICE_CA_CERT_FILENAME = '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'.freeze
+    # rubocop:enable LineLength
 
     attr_accessor :host
     attr_accessor :port
     attr_accessor :token
 
     def validate
-      unless (self.host = self.env[SERVICE_HOST_ENV_NAME]) && (self.port = self.env[SERVICE_PORT_ENV_NAME])
-        raise ConfigError.new("Service host/port is not set")
+      unless (self.host = env[SERVICE_HOST_ENV_NAME]) &&
+             (self.port = env[SERVICE_PORT_ENV_NAME])
+        raise ConfigError, 'Service host/port is not set'
       end
-      raise ConfigError.new("Service token file does not exists") unless File.file?(self.token_file)
-      raise ConfigError.new("Service token file does not exists") unless File.file?(self.ca_cert)
+
+      # rubocop:disable LineLength
+      raise ConfigError, 'Service token file does not exists' unless File.file?(token_file)
+      raise ConfigError, 'Service token file does not exists' unless File.file?(ca_cert)
+      # rubocop:enable LineLength
     end
 
-    def self.in_cluster?()
-      return File.exist?(SERVICE_TOKEN_FILENAME) && File.exist?(SERVICE_CA_CERT_FILENAME)
+    def self.in_cluster?
+      File.exist?(SERVICE_TOKEN_FILENAME) &&
+        File.exist?(SERVICE_CA_CERT_FILENAME)
     end
 
     def env
@@ -56,19 +63,18 @@ def token_file
     end
 
     def load_token
-      open(self.token_file) do |io|
+      File.open(token_file) do |io|
         self.token = io.read.chomp
       end
     end
 
     def configure(configuration)
       validate
       load_token
-      configuration.api_key['authorization'] = "Bearer #{self.token}"
+      configuration.api_key['authorization'] = "Bearer #{token}"
       configuration.scheme = 'https'
-      configuration.host = "#{self.host}:#{self.port}"
-      configuration.ssl_ca_cert = self.ca_cert
+      configuration.host = "#{host}:#{port}"
+      configuration.ssl_ca_cert = ca_cert
     end
   end
-
 end