Simplify derivation of singular & plural method names, fix ManageIQ#307 ManageIQ#367

Also fixes ManageIQ#307 - get_security_context_constraints.kind,
  get_endpoints.kind are now plural as in kubernetes.
Also fixes ManageIQ#367 - create_security_context_constraint now works.

Author: cben

lib/kubeclient/common.rb

@@ -132,21 +132,38 @@ def discover
     end
 
     def self.parse_definition(kind, name)
-      # "name": "componentstatuses", networkpolicies, endpoints
-      # "kind": "ComponentStatus" NetworkPolicy, Endpoints
-      # maintain pre group api compatibility for endpoints and securitycontextconstraints.
-      # See: https://github.com/kubernetes/kubernetes/issues/8115
-      kind = kind[0..-2] if %w[Endpoints SecurityContextConstraints].include?(kind)
-
-      prefix = kind =~ /[A-Z]/ ? kind[0..kind.rindex(/[A-Z]/)] : kind # NetworkP
-      m = name.match(/^#{prefix.downcase}(.*)$/)
-      m && OpenStruct.new(
-        entity_type:   kind, # ComponentStatus
-        resource_name: name, # componentstatuses
-        method_names:  [
-          ClientMixin.underscore_entity(kind),         # component_status
-          ClientMixin.underscore_entity(prefix) + m[1] # component_statuses
-        ]
+      # Kubernetes gives us have 3 inputs:
+      #   kind: "ComponentStatus"
+      #   name: "componentstatuses"
+      #   singularName: "componentstatus" (usually kind.downcase)
+      # and want to derive singular and plural method names, with underscores:
+      #   "component_status"
+      #   "component_statuses"
+      # kind's CamelCase word boundaries determine our placement of underscores.
+
+      if IRREGULAR_NAMES[kind]
+        # In a few cases, the given kind / singularName itself is still plural.
+        # We require a distinct singular method name, so force it.
+        method_names = IRREGULAR_NAMES[kind]
+      else
+        # TODO: respect singularName from discovery?
+        # But how?  If it differs from kind.downcase, kind's word boundaries don't apply.
+        singular_name = kind.downcase
+
+        if name.start_with?(kind.downcase)
+          plural_suffix = name[kind.downcase.length..-1]             # "es"
+          singular_underscores = ClientMixin.underscore_entity(kind) # "component_status"
+          method_names = [singular_underscores, singular_underscores + plural_suffix]
+        else
+          # Something weird, can't infer underscores for plural so just give them up
+          method_names = [singular_name, name]
+        end
+      end
+
+      OpenStruct.new(
+        entity_type:   kind,
+        resource_name: name,
+        method_names:  method_names
       )
     end
 
@@ -435,6 +452,14 @@ def api
 
     private
 
+    IRREGULAR_NAMES = {
+      # In a few cases, the given kind itself is still plural.
+      # https://github.com/kubernetes/kubernetes/issues/8115
+      'Endpoints'                  => %w[endpoint endpoints],
+      'SecurityContextConstraints' => %w[security_context_constraint
+                                         security_context_constraints]
+    }.freeze
+
     # Format datetime according to RFC3339
     def format_datetime(value)
       case value

test/test_endpoint.rb

@@ -1,6 +1,9 @@
 require_relative 'test_helper'
 
-# Endpoint entity tests
+# kind: 'Endpoints' entity tests.
+# This is one of the unusual `kind`s that are already plural (https://github.com/kubernetes/kubernetes/issues/8115).
+# We force singular in method names like 'create_endpoint',
+# but `kind` should remain plural as in kubernetes.
 class TestEndpoint < MiniTest::Test
   def test_create_endpoint
     stub_core_api_list
@@ -44,11 +47,8 @@ def test_get_endpoints
     assert_equal('EndpointsList', collection[:kind])
     assert_equal('v1', collection[:apiVersion])
 
+    # Stripping of 'List' in collection.kind RecursiveOpenStruct mode only is historic.
     collection = client.get_endpoints
-    # TODO: this is wrong.  https://github.com/abonas/kubeclient/issues/307
-    # Kubernetes for single object uses kind: "Endpoints" (!) and
-    # kind: "EndpointsList" for plural.  While we force singular in method names
-    # to distinguish `get_endpoint` vs `get_endpoints`, we should not touch .kind.
-    assert_equal('Endpoint', collection.kind)
+    assert_equal('Endpoints', collection.kind)
   end
 end

test/test_security_context_constraint.rb

@@ -22,13 +22,9 @@ def test_create_security_context_constraint
         type: 'MustRunAs'
       }
     )
-    # TODO: kind here is wrong, this doesn't work at all!
-    # https://github.com/abonas/kubeclient/issues/367
-    #   SecurityContextConstraint in version "v1" cannot be handled as a SecurityContextConstraints:
-    #   no kind "SecurityContextConstraint" is registered for version "security.openshift.io/v1"
     req_body = '{"metadata":{"name":"teleportation"},"runAsUser":{"type":"MustRunAs"},' \
       '"seLinuxContext":{"type":"MustRunAs"},' \
-      '"kind":"SecurityContextConstraint","apiVersion":"security.openshift.io/v1"}'
+      '"kind":"SecurityContextConstraints","apiVersion":"security.openshift.io/v1"}'
 
     stub_request(:post, 'http://localhost:8080/apis/security.openshift.io/v1/securitycontextconstraints')
       .with(body: req_body)
@@ -59,8 +55,8 @@ def test_get_security_context_constraints
     assert_equal('SecurityContextConstraintsList', collection[:kind])
     assert_equal('security.openshift.io/v1', collection[:apiVersion])
 
-    # TODO: this is wrong.  https://github.com/abonas/kubeclient/issues/307
+    # Stripping of 'List' in collection.kind RecursiveOpenStruct mode only is historic.
     collection = client.get_security_context_constraints
-    assert_equal('SecurityContextConstraint', collection.kind)
+    assert_equal('SecurityContextConstraints', collection.kind)
   end
 end