Commits on Sep 12, 2024

1. (go/v4): Refactor e2e-tests for clearer error handling and readable logs …

   Refactors all test cases that use g.Expect(utils.Run(cmd)) to improve both the readability of logs and the clarity of the code.
   
   Changes:
   
   - Replaced occurrences of g.Expect(utils.Run(cmd)) with:
   
   ```go
   output, err := utils.Run(cmd)
   g.Expect(err).NotTo(HaveOccurred())
   g.Expect(string(output)).To(<condition>)
   ```
   
   OR
   
   ```go
   _, err := utils.Run(cmd)
   g.Expect(err).NotTo(HaveOccurred())
   ```
   
   **Motivation**
   
   - **Human-readable logs:** Output is now converted to a string, providing more understandable logs by displaying actual kubectl command results instead of raw byte arrays.
   - **Improved code clarity:** The previous `g.Expect(utils.Run(cmd))` usage did not make it clear that the function returns both output and error. By explicitly handling the output and err variables, the code is more transparent and easier to maintain.
   
   **Example of problematic scenario**
   
   Otherwise, we are unable to check the output when errors are faced. For example
   
   Before the changes:
   
   ```sh
     [FAILED] Timed out after 120.001s.
     The function passed to Eventually failed at /home/runner/work/kubebuilder/kubebuilder/testdata/project-v4-multigroup/test/e2e/e2e_test.go:145 with:
     Metrics endpoint is not ready
     Expected
         <[]uint8 | len:151, cap:1024>: [78, 65, 77, 69, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 69, 78, 68, 80, 79, 73, 78, 84, 83, 32, 32, 32, 65, 71, 69, 10, 112, 114, 111, 106, 101, 99, 116, 45, 118, 52, 45, 109, 117, 108, 116, 105, 103, 114, 111, 117, 112, 45, 99, 111, 110, 116, 114, 111, 108, 108, 101, 114, 45, 109, 97, 110, 97, 103, 101, 114, 45, 109, 101, 116, 114, 105, 99, 115, 45, 115, 101, 114, 118, 105, 99, 101, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 50, 109, 51, 115, 10]
     to contain substring
         <string>: 8443
   
   ```
   
   And then, after the changes:
   
   ```sh
     [FAILED] Timed out after 120.001s.
     The function passed to Eventually failed at /home/runner/work/kubebuilder/kubebuilder/testdata/project-v4-multigroup/test/e2e/e2e_test.go:145 with:
     Metrics endpoint is not ready
     Expected
         <string>: NAME                                                       ENDPOINTS   AGE
         project-v4-multigroup-controller-manager-metrics-service               2m3s
   
     to contain substring
         <string>: 8443
     In [It] at: /home/runner/work/kubebuilder/kubebuilder/testdata/project-v4-multigroup/test/e2e/e2e_test.go:147 @ 09/11/
   
   ```

   

   camilamacedo86 committed Sep 12, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for bb94cdd
   • Browse repository at this point

   Copy the full SHA

   bb94cdd View commit details

   Browse the repository at this point in the history