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.

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

More JSON factset tests #363

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ gemspec

gem 'facter', ENV.fetch('FACTER_GEM_VERSION', nil), require: false

group :test do
gem 'json_schemer'
end

group :development do
gem 'faraday-retry', require: false
gem 'github_changelog_generator', '>= 1.16.4', require: false
Expand Down
94 changes: 94 additions & 0 deletions spec/facts_schema_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# frozen_string_literal: true

require 'spec_helper'
require 'digest'
require 'pathname'
require 'json_schemer'

schema = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you ask the facter devs if they provide any schema?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not really concerned about the validity of the schema overall, since most of them were generated by Facter (hopefully not modified by hand). I am looking for a way to enforce other changes that wouldn't be part of a facter json schema, for example, IP address always being the same, blanked out UUID values, etc. that would help make creating tests with factsets easier.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yes, makes sense. I also asked for a schema, so we can properly validate factsets: puppetlabs/facter#2730

'$id': 'https://voxpupuli.org/facterdb/factset.schema.json',
title: 'Factset',
description: 'A saved puppet facter factset',

'type' => 'object',

properties: {
aio_agent_version: { 'type' => 'string' },
os: {
type: 'object',
properties: {
family: { enum: %w[RedHat Debian Gentoo windows OpenBSD Archlinux Suse FreeBSD Darwin Solaris] },
},
},
},

# "required": ["_meta_generation_date"],

allOf: [
{
if: { properties: { os: { properties: { family: { enum: ['Debian'] } } } } },
then: { required: ['aio_agent_version'] },
# 'else': { 'required': ["aio_agent_version"] }
},
],
}

schemer = JSONSchemer.schema(schema)
RSpec::Matchers.define :be_valid_json do
match do |actual|
content = File.binread(actual)
begin
JSON.parse(content)
true
rescue JSON::ParserError => e
raise "Invalid JSON file #{actual}.\n#{e}"
end
end

failure_message do |actual|
"expected that fact file #{actual} was a valid JSON file."
end
end

RSpec::Matchers.define :have_facter_version do |expected_facter_version, filepath|
match do |actual|
# Simple but naive regex check
actual =~ /^#{expected_facter_version}($|\.)/
end

failure_message do |actual|
"expected that fact file #{filepath} with facter version #{actual} had a facter version that matched #{expected_facter_version}"
end
end

describe 'Factset Schemas are Valid', type: :feature do
before do
ENV['FACTERDB_SKIP_DEFAULTDB'] = nil
FacterDB.instance_variable_set(:@database, nil)
end

project_dir = Pathname.new(__dir__).parent
FacterDB.default_fact_files.each do |filepath|
relative_path = Pathname.new(filepath).relative_path_from(project_dir).to_s
describe relative_path do
subject(:content) do
JSON.parse(File.binread(filepath))
end

it 'contains a valid JSON document' do
expect(filepath).to be_valid_json
end

it 'contains a fact set which matches the facter version' do
facter_dir_path = File.basename(File.dirname(filepath))

expect(content['facterversion']).to have_facter_version(facter_dir_path, filepath)
end

it 'matches the schema' do
valid_json = schemer.validate(content).to_a
expect(valid_json).to be_empty
end
end
end
end
2 changes: 1 addition & 1 deletion spec/facts_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@

it 'contains newer networking facts hash' do
if Gem::Version.new(content['facterversion']) >= Gem::Version.new('3.0.0')
expect(content['networking']['ip']).to not_be_nil.and not_be_empty
expect(content['networking']['ip']).to eq('10.0.2.15')
expect(content['networking']['ip6']).to not_be_nil.and not_be_empty
expect(content['networking']['hostname']).to eq('foo')
expect(content['networking']['domain']).to eq('example.com')
Expand Down
Loading