Stop attempting to cache all subresources in Ansible Operator proxy (#3103)

* Add failing exec test

* Only cache the status subresource request, otherwise pass it through

* add changelog fragment

* Fix tests and improve output

* ensure kubernetes collection is installed for molecule CI tests

Author: fabianvf

changelog/fragments/ansible-no-cache-subresources.yaml

@@ -0,0 +1,9 @@
+entries:
+  - description: >
+      The Ansible Operator proxy no longer will attempt to cache non-status 
+      subresource requests. This will fix the issue where attempting to get
+      Pod logs returns the API Pod resource instead of the log contents.
+
+    kind: "bugfix"
+
+    breaking: false

hack/tests/e2e-ansible-molecule.sh

@@ -14,6 +14,7 @@ pip3 install --user pyasn1==0.4.7 pyasn1-modules==0.2.6 idna==2.8 ipaddress==1.0
 pip3 install --user molecule==3.0.2
 pip3 install --user ansible-lint yamllint
 pip3 install --user docker openshift jmespath
+ansible-galaxy collection install community.kubernetes
 
 deploy_prereqs() {
     header_text "Deploying resources"

pkg/ansible/proxy/cache_response.go

@@ -67,8 +67,8 @@ func (c *cacheResponseHandler) ServeHTTP(w http.ResponseWriter, req *http.Reques
 			break
 		}
 
-		// Skip cache for non-resource requests, not a part of skipCacheLookup for performance.
-		if !r.IsResourceRequest {
+		// Skip cache for non-cacheable requests, not a part of skipCacheLookup for performance.
+		if !r.IsResourceRequest || !(r.Subresource == "" || r.Subresource == "status") {
 			log.Info("Skipping cache lookup", "resource", r)
 			break
 		}

test/ansible/deploy/crds/test.example.com_exectests_crd.yaml renamed to test/ansible/deploy/crds/test.example.com_subresourcestests_crd.yaml

@@ -1,14 +1,14 @@
 apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
-  name: exectests.test.example.com
+  name: subresourcestests.test.example.com
 spec:
   group: test.example.com
   names:
-    kind: ExecTest
-    listKind: ExecTestList
-    plural: exectests
-    singular: exectest
+    kind: SubresourcesTest
+    listKind: SubresourcesTestList
+    plural: subresourcestests
+    singular: subresourcestest
   scope: Namespaced
   subresources:
     status: {}

test/ansible/molecule/cluster/tasks/exec_test.yml

@@ -0,0 +1,29 @@
+---
+- name: Create the test.example.com/v1alpha1.SubresourcesTest
+  k8s:
+    state: present
+    definition:
+      apiVersion: test.example.com/v1alpha1
+      kind: SubresourcesTest
+      metadata:
+        name: subresources-test
+        namespace: '{{ namespace }}'
+      spec:
+        execCommand: "echo 'hello world'"
+        logMessage: "Running..."
+    wait: yes
+    wait_timeout: 300
+    wait_condition:
+      type: Running
+      reason: Successful
+      status: "True"
+  register: subresources_test
+
+- debug: var=subresources_test
+
+- name: Assert stdout and stderr are properly set in status
+  assert:
+    that:
+      - subresources_test.result.status.execCommandStderr == ""
+      - subresources_test.result.status.execCommandStdout == "hello world"
+      - "'Running' in subresources_test.result.status.logs"

test/ansible/molecule/cluster/tasks/subresources_test.yml

@@ -6,7 +6,48 @@
   collections:
     - community.kubernetes
   tasks:
-    - name: Import all test files from tasks/
-      include_tasks: '{{ item }}'
-      with_fileglob:
-        - tasks/*_test.yml
+    - block:
+      - name: Import all test files from tasks/
+        include_tasks: '{{ item }}'
+        with_fileglob:
+          - tasks/*_test.yml
+      rescue:
+        - name: Retrieve relevant resources
+          k8s_info:
+            api_version: '{{ item.api_version }}'
+            kind: '{{ item.kind }}'
+            namespace: '{{ namespace }}'
+          loop:
+            - api_version: v1
+              kind: Pod
+            - api_version: apps/v1
+              kind: Deployment
+            - api_version: v1
+              kind: Secret
+            - api_version: v1
+              kind: ConfigMap
+          register: debug_resources
+
+        - name: Retrieve Pod logs
+          k8s_log:
+            name: '{{ item.metadata.name }}'
+            namespace: '{{ namespace }}'
+          loop: '{{ q("k8s", api_version="v1", kind="Pod", namespace=namespace) }}'
+          register: debug_logs
+
+        - name: Ouput gathered resources
+          debug:
+            var: debug_resources
+
+        - name: Output gathered logs
+          debug:
+            var: item.log_lines
+          loop: '{{ debug_logs.results }}'
+
+        - name: Re-emit failure
+          vars:
+            failed_task:
+              name: '{{ ansible_failed_task.name }}'
+              result: '{{ ansible_failed_result }}'
+          fail:
+            msg: '{{ failed_task }}'

test/ansible/molecule/cluster/verify.yml

@@ -21,7 +21,7 @@
                 args:
                   - "/bin/sh"
                   - "-c"
-                  - "while true;do date;sleep 5;done"
+                  - "while true ; do echo '{{ log_message }}' ; sleep 5 ; done"
         wait: yes
 
     - name: Execute command in busybox pod
@@ -33,12 +33,19 @@
 
     - debug: var=exec_result
 
-    - name: Write result to resource status
+    - name: Get logs from busybox pod
+      k8s_log:
+        name: '{{ meta.name }}-busybox'
+        namespace: '{{ meta.namespace }}'
+      register: log_result
+
+    - name: Write results to resource status
       k8s_status:
         api_version: test.example.com/v1alpha1
-        kind: ExecTest
+        kind: SubresourcesTest
         name: '{{ meta.name }}'
         namespace: '{{ meta.namespace }}'
         status:
           execCommandStdout: '{{ exec_result.stdout.strip() }}'
           execCommandStderr: '{{ exec_result.stderr.strip() }}'
+          logs: '{{ log_result.log }}'

test/ansible/playbooks/exec.yml renamed to test/ansible/playbooks/subresources.yml

@@ -11,8 +11,8 @@
 
 - version: v1alpha1
   group: test.example.com
-  kind: ExecTest
-  playbook: playbooks/exec.yml
+  kind: SubresourcesTest
+  playbook: playbooks/subresources.yml
 
 - version: v1
   group: ""