Support an extension to tmpfile #1735
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #1735 +/- ##
==========================================
- Coverage 74.65% 74.55% -0.10%
==========================================
Files 81 81
Lines 4494 4508 +14
==========================================
+ Hits 3355 3361 +6
- Misses 1139 1147 +8
☔ View full report in Codecov by Sentry. |
lib/beaker/host/aix/file.rb
Outdated
| def tmpfile(name = '') | ||
| execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum} && echo /tmp/#{name}.${rndnum}") | ||
| def tmpfile(name = '', extension = nil) | ||
| execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum} && echo /tmp/#{name}.${rndnum}#{extension}") |
There was a problem hiding this comment.
This looks bad (regarding the uniqueness of the generated temporary file name) but I guess AIX is that bad 🤷
| execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum} && echo /tmp/#{name}.${rndnum}#{extension}") | |
| execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum}#{extension} && echo /tmp/#{name}.${rndnum}#{extension}") |
| def tmpfile(name = '') | ||
| execute("mktemp -t #{name}.XXXXXX") | ||
| def tmpfile(name = '', extension = nil) | ||
| execute("mktemp -t #{name}.XXXXXX#{extension}") |
There was a problem hiding this comment.
This is not portable, for example the FreeBSD man page for mktemp(1) says:
The template may be any file name with some number of ‘Xs’ appended to it, for example
/tmp/temp.XXXX. The trailing ‘Xs’ are replaced with the current process number and/or a unique letter combination.
And indeed, it does not do the right thing on FreeBSD:
romain@zappy ~ % mktemp -t foo.XXXX.gz
/tmp/foo.XXXX.gz.uAo9BCUuI am not sure there is something guaranteed to be portable given mktemp is not defined by POSIX. The GNU/Linux and FreeBSD man pages at least contain references to function that support this:
The
mkstemps()andmkostemps()functions act the same asmkstemp()andmkostemp()respectively, except they permit a suffix to exist in the template. The template should be of the form/tmp/tmpXXXXXXsuffix. Themkstemps()andmkostemps()function are told the length of the suffix string.
There was a problem hiding this comment.
Thanks for that insight. I wonder what would be best to do here. Given Windows does not implement it either, would it be OK to mention it as a potential compatibility issue in a param documentation? I mean, in the end it still gives you a unique filename.
Edit: https://hauweele.net/~gawen/blog/?p=2529 suggests mktemp -d to create a directory and then create a file with a static name. I guess that could be implemented for FreeBSD while using GNU mktemp's feature on Linux. However, it is a risk since it's multiple code paths.
There was a problem hiding this comment.
Wait wait wait, why don't we use Tempfile from stdlib which already has support for this:
The basename parameter is used to determine the name of the temporary file. You can either pass a String or an Array with 2 String elements. In the former form, the temporary file’s base name will begin with the given string. In the latter form, the temporary file’s base name will begin with the array’s first element, and end with the second element. For example:
file = Tempfile.new('hello')
file.path # => something like: "/tmp/hello2843-8392-92849382--0"
# Use the Array form to enforce an extension in the filename:
file = Tempfile.new(['hello', '.jpg'])
file.path # => something like: "/tmp/hello2843-8392-92849382--0.jpg"There was a problem hiding this comment.
Because the Ruby part is executed on the host, not the target. You may need to do some wacky things to get Ruby to execute on the target host and in beaker we can't assume it's present since Puppet may not have been bootstrapped.
|
@smortex would you be OK with merging this? |
ekohl
force-pushed
the
tmpfile-extension
branch
from
304c91b
to
935db18
Compare
ekohl
force-pushed
the
tmpfile-extension
branch
from
935db18
to
2ba451f
Compare
Sometimes tools expect a certain extension or it is just cleaner to have one. This adds an optional parameter which keeps the API compatible.
bastelfreak
force-pushed
the
tmpfile-extension
branch
from
2ba451f
to
37dd194
Compare
Sometimes tools expect a certain extension or it is just cleaner to have one. This adds an optional parameter which keeps the API compatible.