Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance cmp matcher to work with symbols, fix file documentation #2224

Merged
merged 4 commits into from
Oct 7, 2017
Merged

Enhance cmp matcher to work with symbols, fix file documentation #2224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4129f5
Enhance cmp matcher to work with symbols
adamleff Oct 6, 2017
29a7c37
Fix documentation for file type character_device
adamleff Oct 6, 2017
9414b87
Fix docs for block_device
adamleff Oct 6, 2017
d67908c
Fix file mtime docs
adamleff Oct 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 28 additions & 27 deletions docs/resources/file.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,15 @@ The following examples show how to use this InSpec audit resource.
### Test if a path is a file and not a directory

describe file('/proc/version') do
its('type') { should eq 'file' }
its('type') { should cmp 'file' }
it { should be_file }
it { should_not be_directory }
end

### Test if a file is a symbolic link

describe file('/dev/stdout') do
its('type') { should eq 'symlink' }
its('type') { should cmp 'symlink' }
it { should be_symlink }
it { should_not be_file }
it { should_not be_directory }
Expand All @@ -75,7 +75,7 @@ The following examples show how to use this InSpec audit resource.
### Test if a file is a character device

describe file('/dev/zero') do
its('type') { should eq 'character' }
its('type') { should cmp 'character' }
it { should be_character_device }
it { should_not be_file }
it { should_not be_directory }
Expand All @@ -84,7 +84,7 @@ The following examples show how to use this InSpec audit resource.
### Test if a file is a block device

describe file('/dev/zero') do
its('type') { should eq 'block' }
its('type') { should cmp 'block' }
it { should be_character_device }
it { should_not be_file }
it { should_not be_directory }
Expand All @@ -110,9 +110,9 @@ The following examples show how to use this InSpec audit resource.

### Test the mtime for a file

describe file('/').mtime.to_i do
it { should <= Time.now.to_i }
it { should >= Time.now.to_i - 1000}
describe file('/') do
its('mtime') { should <= Time.now.to_i }
its('mtime') { should >= Time.now.to_i - 1000 }
end

### Test that a file's size is between 64 and 10240
Expand Down Expand Up @@ -193,7 +193,7 @@ For example, for the following symlink:
it { should be_owned_by 'ovirtagent' }
it { should be_grouped_into 'ovirtagent' }
end

<br>

## Matchers
Expand Down Expand Up @@ -421,15 +421,11 @@ The `mode` matcher tests if the mode assigned to the file matches the specified

### mtime

The `mtime` matcher tests if the file modification time for the file matches the specified value:
The `mtime` matcher tests if the file modification time for the file matches the specified value. The mtime, where supported, is returned as the number of seconds since the epoch.

its('mtime') { should eq 'October 31 2015 12:10:45' }

or:

describe file('/').mtime.to_i do
it { should <= Time.now.to_i }
it { should >= Time.now.to_i - 1000}
describe file('/') do
its('mtime') { should <= Time.now.to_i }
its('mtime') { should >= Time.now.to_i - 1000 }
end

### owner
Expand Down Expand Up @@ -472,21 +468,26 @@ Less than:

### type

The `type` matcher tests if the first letter of the file's mode string contains one of the following characters:
The `type` matcher tests for the file type. The available types are:

* `file`: the object is a file
* `directory`: the object is a directory
* `link`: the object is a symbolic link
* `pipe`: the object is a named pipe
* `socket`: the object is a socket
* `character_device`: the object is a character device
* `block_device`: the object is a block device
* `door`: the object is a door device

* `-` or `f` (the file is a file); use `'file` to test for this file type
* `d` (the file is a directory); use `'directory` to test for this file type
* `l` (the file is a symbolic link); use `'link` to test for this file type
* `p` (the file is a named pipe); use `'pipe` to test for this file type
* `s` (the file is a socket); use `'socket` to test for this file type
* `c` (the file is a character device); use `'character` to test for this file type
* `b` (the file is a block device); use `'block` to test for this file type
* `D` (the file is a door); use `'door` to test for this file type
The `type` method usually returns the type as a Ruby "symbol". We recommend using the `cmp` matcher to match
either by symbol or string.

For example:

its('type') { should eq 'file' }
its('type') { should eq :file }
its('type') { should cmp 'file' }

or:

its('type') { should eq 'socket' }
its('type') { should eq :socket }
its('type') { should cmp 'socket' }
2 changes: 2 additions & 0 deletions lib/matchers/matchers.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,8 @@ def try_match(actual, op, expected) # rubocop:disable Metrics/CyclomaticComplexi
return actual.to_i.method(op).call(expected)
elsif expected.is_a?(Float) && float?(actual)
return actual.to_f.method(op).call(expected)
elsif actual.is_a?(Symbol) && expected.is_a?(String)
return actual.to_s.method(op).call(expected)
elsif octal?(expected) && actual.is_a?(Integer)
return actual.method(op).call(expected.to_i(8))
end
Expand Down