fix: list generator elements should be optional

[blakepettersson]

A bug was reported, where an applicationset with an empty elements array, when created with argocd appset create <filename>.yaml gets a ...list.elements: Required value error.

My hypothesis is that when calling the K8s API, golang JSON marshalling mangles the empty elements array to nil, rather than creating an empty array when submitting the POST.

Still need to figure out why the same setup seemingly works fine when the same appset is in an app-of-apps.

Fixes #17450

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
• The title of the PR states what changed and the related issues number (used for the release note).
• The title of the PR conforms to the Toolchain Guide
• I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
• I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
• Does this PR require documentation updates?
• I've updated documentation as required by this PR.
• I have signed off all my commits as required by DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My build is green (troubleshooting builds).
• My new feature complies with the feature status guidelines.
• I have added a brief description of why this PR is necessary and/or what this PR solves.
• Optional. My organization is added to USERS.md.
• Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

[blakepettersson]

So, looking at this further the discrepancy between how this works in an app-of-apps setting and when invoked using argocd appset create seems to be the following:

1. When invoked from appset create .. the ApplicationSet gets marshaled as an ApplicationSet, without any indirection, causing elements to be nil.
2. When synced in SyncAppState, the ApplicationSet gets marshaled as an Unstructured, where there is a bunch of weird marshaling logic going on. This causes the marshaled JSON string to have an empty array of elements.

Thoughts?

[blakepettersson]

An example appset, which without this patch would fail with appset create .... If this appset is in an app-of-apps, it'd instead fail at a later stage (since there's no repo with that name, but that's another story).

apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
  annotations:
    argocd.argoproj.io/sync-wave: "0"
  name: some-random-app
  namespace: argocd
spec:
  goTemplate: true
  generators:
    - matrix:
        generators:
          - git:
              repoURL: [email protected]:blakepettersson/some-random-repo.git
              revision: main
              files:
                - path: some-random-file.yaml
          - list:
              elements: []
              elementsYaml: "{{ .clusters | toJson }}"

  syncPolicy: {}
  template:
    metadata:
      name: "some-random-app-{{.env}}"
    spec:
      project: default
      source:
        repoURL: [email protected]:blakepettersson/some-random-repo.git
        path: "some-random-path/{{.env}}"
        targetRevision: main
      destination:
        name: '{{.name}}'
        namespace: 'some-random-app-{{.env}}'
      ignoreDifferences:
        - group: argoproj.io
          jsonPointers:
            - /status
          kind: Application
      syncPolicy:
        automated:
          allowEmpty: true
          prune: true
          selfHeal: true
        syncOptions:
          - CreateNamespace=true
          - ApplyOutOfSyncOnly=true

[jannfis]

A bug was reported

Reported where? Care to link it, please?

[blakepettersson]

Reported where?

Internally by an Akuity customer - I cannot link to the reported bug sadly 😞

[jannfis]

I cannot link to the reported bug sadly

Care to open a bug on GitHub describing this problem? It would help others in the community who happen to stumble over it.

[blakepettersson]

Sure thing, here's the linked issue: #17450

[alexmt]

LGTM!

[blakepettersson]

/cherry-pick release-2.9

[blakepettersson]

/cherry-pick release-2.10

[blakepettersson]

/cherry-pick release-2.8