Frizbee refactoring - support for Dockerfile, docker:// actions, etc.

[rdimitrov]

The following PR aimed to tidy up the packages, add missing functionality and fix a few of the opened issues.

Details:

• Grouped the code base into 2 separate packages - one for parsing actions and another one for parsing container images
• Fixed the issue of altering the formatting of the file when replacing a reference
• Fixed an issue with caching not working properly for container images
• Made the cache to be scoped per-instance of the replacer and not per-operation. This should help reduce the overall API consumption.
• Added support for parsing Dockerfiles
• Added support for parsing GitHub Actions referenced by docker://
• Added the --platform/-p flag. The code is there but it doesn't work now as there's an opened issue in the underlying library. When debugging the underlying library it turned out that the platform configuration is not really taken into account while fetching the manifest. I can remove the code if needed or mark it as experimental until the issue is resolved.
• Updated the README.md file - added the Frizbee logo and updated the content
• Updated the test coverage to 69%

Fixes: #55
Fixes: #67
Fixes: #77
Fixes: #137
Fixes: #138
Closes: #61

[jhrozek]

I went through some of the code, not all of it but as you said, a lot of it is moving things around, so I've been trying to orient myself and take notes what is moved where.

I think looking at the Minder PR that the API changes are OK and searching GH, Minder is the only API user of frizbee, so if we want to break the API, now is still a good time.

But I know we have CLI users (one wrote a post about frizbee). I see that you added aliases for the k8s and dockerhub commands, but what do you think about temporary adding aliases for one as well, would that be possible?

Also the image list command doesn't seem to work all that well for me, I tested with this manifest I had around:

apiVersion: v1
kind: Pod
metadata:
  name: mount-host
  namespace: playground
spec:
  containers:
  - name: mount-host
    image: alpine
    command: ["sleep"]
    args: ["infinity"]
    volumeMounts:
    - name: host-root
      mountPath: /host
      readOnly: true
  volumes:
  - name: host-root
    hostPath:
      path: /
      type: Directory

and I got:

frizbee image list ~/devel/playground/k8s/mount-host.yaml
+----+-----------+------+--------+
| NO |   TYPE    | NAME |  REF   |
+----+-----------+------+--------+
|  1 | container |      | latest |
+----+-----------+------+--------+

shouldn't name print something?

[rdimitrov]

@jhrozek - Thanks for the review!

1. I'll try to see if I can add the one command too. I have to see if it would work properly with the missing -d flag though.
2. That's a bug. I'll fix it and add that use case as part of the unit tests 👍

[rdimitrov]

@jhrozek - Thanks again! This was indeed a bug - I was accepting the empty string from the flag's default value for overwriting the regex which caused this failure. It should be fixed now 👍

Added more tests cases which bumped the coverage to 69%.

[rdimitrov]

Draft branches/PRs for the two projects I found that depend on Frizbee -

• pinned-actions - https://github.com/rdimitrov/pinned-actions/tree/bump-frizbee
• minder - Switch the pinned action support to use the new frizbee version mindersec/minder#3465

[jhrozek]

I tested replacing both "normal" actions and docker actions through and a bunch of things in the CLI. I don't claim I reviewed every single line of the PR, but the API looks good.

I know that @JAORMX was also planning to take a look so don't merge just yet, but ack from my part.

Thanks for all the work, this makes frizbee much better.

[JAORMX]

lgtm. Went through the library usages and tried out the CLI. shipit