Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-09-20 14:31:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add support for shallow link paths (#3168)

Browse source 
* Add support for shallow link paths
* Improve documentation of the

Signed-off-by: Colin Hebert <hebert.colin@gmail.com>
This commit is contained in:
Colin Hebert 2018-06-26 21:47:00 +10:00 committed by Jared Quick
parent 68b8ea7bce
commit 7deed13425
2 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/resources/file.md.erb
View file

@ -33,7 +33,7 @@ content, size, basename, path, owner, group, type
### Unix/Linux Properties
symlink, mode, link_path, mtime, size, selinux\_label, md5sum, sha256sum, path, source, source\_path, uid, gid
symlink, mode, link_path, shallow_link_path, mtime, size, selinux\_label, md5sum, sha256sum, path, source, source\_path, uid, gid
### Windows Properties
@ -74,10 +74,17 @@ The following examples show how to use this InSpec audit resource.
### link_path
The `link_path` property tests if the file exists at the specified path. If the file is a symlink,
InSpec will resolve the symlink and return the ultimate linked file.
InSpec will resolve the symlink recursively and return the ultimate linked file.
its('link_path') { should eq '/some/path/to/file' }
### shallow_link_path
The `shallow_link_path`` property returns the path that the file refers to, only resolving
it once (that is, it performs a readlink operation). If the file is not a symlink, nil is returned.
its('shallow_link_path') { should eq '/some/path/to/file' }
### md5sum
The `md5sum` property tests if the MD5 checksum for a file matches the specified value.
@ -316,7 +323,7 @@ The following example shows how to use the `file` audit resource to verify if th
### Test parameters of symlinked file
If you need to test the parameters of the target file for a symlink, you can use the `link_path` method for the `file` resource.
If you need to test the parameters of the target file for a symlink, you can use the `link_path` (recursive resolution) or `shallow_link_path` (direct link) method for the `file` resource.
For example, for the following symlink:

2
lib/resources/file.rb
View file

@ -44,7 +44,7 @@ module Inspec::Resources
%w{
type exist? file? block_device? character_device? socket? directory?
symlink? pipe? mode mode? owner owned_by? group grouped_into?
link_path linked_to? mtime size selinux_label immutable?
link_path shallow_link_path linked_to? mtime size selinux_label immutable?
product_version file_version version? md5sum sha256sum
path basename source source_path uid gid
}.each do |m|