Added --output=json flag to epinio namespace [list|show]

[enrichman]

This PR adds the support for the JSON output in the namespace list and namespace show commands.

When selected it will silence the warning version, and it will still output a user-readable error in case of failure. The exit code will be a non-zero though. Not sure if we should provide a JSON error as well instead of a plain text.

-> % epinio namespace show workspace --output json | jq
{
  "meta": {
    "name": "workspace",
    "createdAt": "2023-09-04T13:04:52Z"
  },
  "apps": [
    "sample"
  ]
}

It also adds an enumValue flag that can be used to provide a flag with a fixed set of values, and its completion func.

[codecov]

Codecov Report

Patch coverage is 70.68% of modified lines.

Files Changed	Coverage
internal/cli/commons.go	11.11%
internal/cli/termui/ui.go	70.00%
internal/cli/enum_flag.go	71.42%
internal/cli/namespaces.go	100.00%
internal/cli/root.go	100.00%
internal/cli/usercmd/namespace.go	100.00%

📢 Thoughts on this report? Let us know!.

[gitricko]

Great!

[mmartin24]

Tested in branch and seems to be ok:

• Check default without flag outputs to text:

➜  epinio git:(2527-add-output-json-flag-to-epinio-namespace-command) ✗ epinio namespace show workspace   

🚢  Showing namespace...
Name: workspace

✔️  Details:
|      KEY       |                VALUE                |
|----------------|-------------------------------------|
| Name           | workspace                           |
| Created        | 2023-09-05 15:43:02 +0200 CEST      |
| Applications   | testapp-cli                         |
| Configurations | xcfefa578ebf738cc24fe12a0f5a3-mysql |

• Checked -o json correctly outputs to json format:

➜  epinio git:(2527-add-output-json-flag-to-epinio-namespace-command) ✗ epinio namespace show workspace -o json | jq
{
  "meta": {
    "name": "workspace",
    "createdAt": "2023-09-05T13:43:02Z"
  },
  "apps": [
    "testapp-cli"
  ],
  "configurations": [
    "xcfefa578ebf738cc24fe12a0f5a3-mysql"
  ]

• Checked both flags -o, --output work
• Checked worked with epinio namespace list;

➜  epinio git:(2527-add-output-json-flag-to-epinio-namespace-command) ✗ epinio namespace list workspace -o json | jq
[
  {
    "meta": {
      "name": "ns-1",
      "createdAt": "2023-09-05T14:00:35Z"
    }
  },
  {
    "meta": {
      "name": "workspace",
      "createdAt": "2023-09-05T13:43:02Z"
    },
    "apps": [
      "testapp-cli"
    ],
    "configurations": [
      "xcfefa578ebf738cc24fe12a0f5a3-mysql"
    ]
  }
]

---

@enrichman, the only thing I noted was a time difference between text and json output due to its format:

I am not sure if we want to do something about it or assume this output difference as ok.

[enrichman]

@mmartin24 I would say that is OK. As a user I'm expecting the text format to be easy to ready and so the local timezone formatting is expected.

[mmartin24]

Rechecked in Epinio Server Version: v1.10.0-rc2

• Checked epinio namespace list -o json

➜  epinio git:(main) ✗ epinio namespace list -o json  | jq
[
  {
    "meta": {
      "name": "ns-1",
      "createdAt": "2023-09-20T13:21:36Z"
    }
  },
  {
    "meta": {
      "name": "workspace",
      "createdAt": "2023-09-20T11:59:06Z"
    },
    "configurations": [
      "config-1",
      "xcfefa578ebf738cc24fe12a0f5a3-mysql"
    ]
  }
]

• Checked epinio namespace show workspace -o json

➜  epinio git:(main) ✗ epinio namespace show workspace -o json  | jq
{
  "meta": {
    "name": "workspace",
    "createdAt": "2023-09-20T11:59:06Z"
  },
  "configurations": [
    "config-1",
    "xcfefa578ebf738cc24fe12a0f5a3-mysql"
  ]
}

[mmartin24]

Sanity check on 1.10.0:

  epinio git:(main) epinio namespace list -o json  | jq                                               
[
  {
    "meta": {
      "name": "workspace",
      "createdAt": "2023-09-25T10:06:13Z"
    }
  }
]
➜  epinio git:(main) epinio info                        

✔️  Epinio Environment
Platform: k3s
Kubernetes Version: v1.25.4+k3s1
Epinio Server Version: v1.10.0
Epinio Client Version: v1.10.0