imagebuildah: Support custom image reference lookup for cache push/pull

[aaronlehmann]

What type of PR is this?

/kind api-change

What this PR does / why we need it:

This allows callers to provide custom SourceLookupReferenceFunc and DestinationLookupReferenceFunc for cache pull/push. These can be used to implement custom blob caches, and to wrap the reference being pushed/pulled to influence the copy behavior.

How to verify it

Verification isn't really necessary since this is just plumbing through functions for other code calling into buildah, but one could write a test program that embeds buildah and supplies its own funcs here.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

n/a

Does this PR introduce a user-facing change?

None

[packit-as-a-service]

Ephemeral COPR build failed. @containers/packit-build please check.

[rhatdan]

Please add tests.

[aaronlehmann]

Please add tests.

I think this is a tricky thing to construct a test for since it requires pushing cache to/from a registry. The integration tests do this, but they use a real buildah binary that doesn't use these options.

I saw there is a TestConformance test which exercises imagebuildah.BuildDockerfiles, but this doesn't have a registry available to test with, and hacking either hacking that into this test or creating a similar test with a registry feels like it would involve creating a lot of infrastructure just to test something extremely simple.

One option would be to add hidden flags to the buildah build subcommand that rewrite the cache source/destination refs (basically just for testing purposes - I don't think they would have a practical use), and exercise that in integration tests. Does that sound like a good approach? Do you have any other ideas?

[rhatdan]

No after looking at the PR more closely, I think we can let it in without tests.

[aaronlehmann]

Cool, are there any other changes you'd like here?

[mtrmac]

I am just randomly passing by and I am expressing no opinion on the cost/benefit of adding these indirections.

[mtrmac]

Thanks!

Implementation LGTM. I’ll let others decide about the cost/benefit of the feature.

[rhatdan]

/lgtm
/approve
Thanks @aaronlehmann

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aaronlehmann, rhatdan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [rhatdan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[rhatdan]

We are going to have to revert this PR. We should not have let libimage leak into the buildah/define directory. This forces podman-remote to grow hugely in size. We should define these functions in a directory other then define/ and then pass them into the executor.