Rewrite artifactory_sha1 function with puppet v4 api #323
Conversation
|
@eputnam puppet-strings doesn't seem very happy with me. |
|
@alexjfisher should the docs be above the function instead of inside it perhaps? Now it looks like it's documenting the dispatch. |
|
having them above the dispatch is correct. i'm going to take a closer look. |
|
I think it's the |
|
looks like this is another bug. if |
| dispatch :artifactory_checksum do | ||
| param 'Stdlib::HTTPUrl', :url | ||
| optional_param "Enum['sha1','sha256','md5']", :checksum_type | ||
| return_type 'String' |
There was a problem hiding this comment.
If I remove this line, the docs generate.
Equally, I can also add a # @return [String] The checksum above.
I don't think this should be required though as it doesn't add much if I'm already doing the return_type validation thing.
There was a problem hiding this comment.
Old v3 API function is removed, and new `archive::artifactory_checksum` function added. Puppet 4 API functions should not have issues with environment isolation. This is a breaking change. The function is renamed and has been upgraded. It can now return md5 or sha256 checksums as well as sha1. The function now expects the artifact URL and will convert to the API url internally. (This was previously done in the calling puppet code.)
alexjfisher
force-pushed
the
migrate_artifactory_sha1_function
branch
from
fc97bf7
to
e872b14
Compare
alexjfisher
changed the title
| end | ||
| # Mock Puppet V4 API ruby function with a puppet language function equivalent | ||
| let(:pre_condition) do | ||
| 'function archive::artifactory_checksum($url,$type) { return \'0d4f4b4b039c10917cfc49f6f6be71e4\' }' |
There was a problem hiding this comment.
Many thanks to @TraGicCode on slack for suggesting this method of mocking puppet v4 API ruby functions with puppet language functions.
Old v3 API function is removed, and new
archive::artifactory_checksumfunction added. Puppet 4 API functions should not have issues with
environment isolation.
This is a breaking change. The function is renamed and has been
upgraded. It can now return md5 or sha256 checksums as well as sha1.
The function now expects the artifact URL and will convert to the API
url internally. (This was previously done in the calling puppet code.)