rtyler
/
zonespec
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Start fleshing out the README

This commit is contained in:
R. Tyler Croy 2017-01-17 20:59:27 -08:00
parent 11e715b50f
commit ac7a272d21
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
2 changed files with 27 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.adoc Normal file
View File

@ -0,0 +1,27 @@
= Zonespec
A simple little gem for acceptance testing a provisioned DNS server's ability
to respond based on records which were defined in a Zonefile.
[source,ruby]
----
require 'spec_helper'
require 'zonespec/rspec'
describe dns_server('8.8.8.8') do
describe zone('jenkins.io', 'path/to/jenkins.io.zone') do
# Generate all the test cases for CNAME records
verify_all_cnames!
# Generate all the test cases for A records
verify_all_a_records!
end
# Instead of testing with a Zone file, it's possible to describe the specific
# expectations manually.
describe zone('jenkins.io') do
it { should serve_cname('www', 'jenkins.io.') }
it { should serve_a_record('ftp', '127.0.0.1') }
end
end
----

36
README.md
View File

@ -1,36 +0,0 @@
# Zonespec
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zonespec`. To experiment with that code, run `bin/console` for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'zonespec'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install zonespec
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zonespec.