feat: add --why flag for zarf dev find-images

[waveywaves]

Description

Add a --why flag for zarf dev find-images

Related Issue

Fixes #2272

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Other (security config, docs update, etc)

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[netlify]

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	260ed65
🔍 Latest deploy log	https://app.netlify.com/sites/zarf-docs/deploys/65e742b3efac590009670691

[waveywaves]

Partial (relevant) test output

$ build/zarf-mac-apple dev find-images examples/dos-games --why defenseunicorns/zarf-game:multi-tile-dark --tmpdir /var/folders/v7/yqyq_d6x2996hfnnwvgs5f080000gn/T/zarf-1881051164

 NOTE  Using config file /Users/vibhavbobade/go/src/github.com/defenseunicorns/zarf/zarf-config.toml

 NOTE  Saving log file to
       /var/folders/v7/yqyq_d6x2996hfnnwvgs5f080000gn/T/zarf-2024-02-20-20-44-58-2844959790.log

 NOTE  Using build directory examples/dos-games
  ✔  Looking for images in component "baseline" across 3 resources              
  ✔  Looking up cosign artifacts for discovered images (0/1)                    
component: baseline
manifests: multi-games
resources: 

apiVersion: apps/v1
kind: Deployment
metadata:
  name: game
spec:
  selector:
    matchLabels:
      app: game
  template:
    metadata:
      labels:
        app: game
    spec:
      containers:
      - image: defenseunicorns/zarf-game:multi-tile-dark
        name: multi-game
        ports:
        - containerPort: 8000
          name: http
          protocol: TCP
        resources:
          limits:
            cpu: 250m
            memory: 128Mi
          requests:
            cpu: 50m
            memory: 32Mi

[AustinAbro321]

Currently the code will output images not marked with the --why flag with an empty resources block. I believe the intended behavior is to only show images marked by the --why flag, but @Racer159 can correct me as the issue author.

Output from examples/manifests with ../../build/zarf dev find-images --why=httpd:alpine3.18

component: httpd-local
manifests: simple-httpd-deployment
resources: 

apiVersion: apps/v1
kind: Deployment
metadata:
  name: httpd-deployment
spec:
  replicas: 2
  selector:
    matchLabels:
      app: httpd
  template:
    metadata:
      labels:
        app: httpd
    spec:
      containers:
      - image: httpd:alpine3.18
        name: httpd
        ports:
        - containerPort: 80

component: nginx-remote
manifests: simple-nginx-deployment
resources: 
component: podinfo-kustomize
manifests: simple-podinfo-deployment
resources: 

[waveywaves]

I am going to make the following changes

• don't mention other components for --why based on feat: add --why flag for zarf dev find-images #2309 (comment) only show the resources with the relevant image
• simplify the logic with a helper function feat: add --why flag for zarf dev find-images #2309 (comment)
• parse manifests and charts feat: add --why flag for zarf dev find-images #2309 (comment)

[waveywaves]

Updated the PR based on the reviews @Racer159 @lucasrod16 @AustinAbro321

[lucasrod16]

@waveywaves there are some merge conflicts that will need to be resolved

[waveywaves]

@waveywaves there are some merge conflicts that will need to be resolved

@lucasrod16 I will do the needful

[waveywaves]

seems like the k3d test is flaking, can we restart that test ?
@lucasrod16 updated the PR based on the changes you proposed

[waveywaves]

the e2e-test-with-cluster test failed twice at a single kiwix data injection test against a minikube cluster
first time the test failed because zarf could not connect to the cluster
and right now it has failed because the test could not find a pod which was successfully deployed as seen in the logs below

https://github.com/defenseunicorns/zarf/actions/runs/8013856761/job/21891629494?pr=2309#step:8:5575

running the same possibly flakey TestDataInjection passes locally with minikube

--- PASS: TestDataInjection (47.62s)
PASS
ok      github.com/defenseunicorns/zarf/src/test/e2e    48.707s

[lucasrod16]

Few minor tweaks. Otherwise, this looks good to me!

[waveywaves]

@lucasrod16 updated the PR

[lucasrod16]

lgtm

[Racer159]

One small bug, but otherwise super close!

[Racer159]

lgtm