impl: add a retry with result function (#2837)

[alevenberg]

Second part of the attempt to fix #1717

Description

Adds a retry loop for the remote image download

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

• Includes unit tests
• Adds integration tests if needed.

See the contribution guide for more details.

I'm not sure the best way to test the changes. Any suggestions?

Reviewer Notes

• The code flow looks good.
• Unit tests and or integration tests added.

Release Notes

• kaniko adds a new flag --image-download-retry to retry when downloading an image

[JeromeJu]

Thanks for the PR, the codes look good. Would you mind adding some more tests for examining the expected behaviour?

[alevenberg]

Added unit tests. I ran go test pkg/image/remote/remote_test.go pkg/image/remote/remote.go to verify the unit test and
find . -name "*.go" | grep -v vendor/ | xargs gofmt -l -s -w to lint the files

[aaron-prindle]

Left one nit comment, once that is resolved we should be able to merge this 🎊

[alevenberg]

Done! Thanks for the reviews 👍