Filling out initial rubocop support for metadata.rb and the Gemfile.
Removing tailor, cleaning up metadata and Gemfile and adding TESTING.md Addresses: blueprint rubocop-for-ops-database Change-Id: Ia2e02864b3c157b44cf0cf483801c6bb19f83054
This commit is contained in:
Matt Ray
galstrom21
parent
36f67cef93
commit
762889aa86
|
|
@ -0,0 +1,7 @@
|
|||
# UTF-8 headers not generally in these files
|
||||
Encoding:
|
||||
Enabled: false
|
||||
|
||||
# ignore long lines
|
||||
LineLength:
|
||||
Enabled: false
|
||||
25
.tailor
25
.tailor
|
|
@ -1,25 +0,0 @@
|
|||
Tailor.config do |config|
|
||||
config.formatters "text"
|
||||
config.file_set '**/*.rb' do |style|
|
||||
style.max_line_length 80, level: :off
|
||||
style.allow_camel_case_methods false, level: :error
|
||||
style.allow_hard_tabs false, level: :error
|
||||
style.allow_screaming_snake_case_classes false, level: :error
|
||||
style.allow_trailing_line_spaces false, level: :error
|
||||
style.allow_invalid_ruby false, level: :warn
|
||||
style.indentation_spaces 2, level: :error
|
||||
style.max_code_lines_in_class 300, level: :error
|
||||
style.max_code_lines_in_method 30, level: :error
|
||||
style.spaces_after_comma 1, level: :error
|
||||
style.spaces_after_lbrace 1, level: :error
|
||||
style.spaces_after_lbracket 0, level: :error
|
||||
style.spaces_after_lparen 0, level: :error
|
||||
style.spaces_before_comma 0, level: :error
|
||||
style.spaces_before_lbrace 1, level: :error
|
||||
style.spaces_before_rbrace 1, level: :error
|
||||
style.spaces_before_rbracket 0, level: :error
|
||||
style.spaces_before_rparen 0, level: :error
|
||||
style.spaces_in_empty_braces 0, level: :error
|
||||
style.trailing_newlines 1, level: :error
|
||||
end
|
||||
end
|
||||
16
Gemfile
16
Gemfile
|
|
@ -1,9 +1,9 @@
|
|||
source "https://rubygems.org"
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem "chef", "~> 11.4.4"
|
||||
gem "json", "<= 1.7.7" # chef 11 dependency
|
||||
gem "berkshelf", "~> 2.0.10"
|
||||
gem "chefspec", "~> 3.0.2"
|
||||
gem "foodcritic", "~> 3.0.3"
|
||||
gem "strainer"
|
||||
gem "rubocop"
|
||||
gem 'chef', '~> 11.8'
|
||||
gem 'json', '<= 1.7.7' # chef 11 dependency
|
||||
gem 'berkshelf', '~> 2.0.10'
|
||||
gem 'chefspec', '~> 3.1.4'
|
||||
gem 'foodcritic', '~> 3.0.3'
|
||||
gem 'strainer'
|
||||
gem 'rubocop', '>= 0.16.0'
|
||||
|
|
|
|||
61
Gemfile.lock
61
Gemfile.lock
|
|
@ -37,33 +37,46 @@ GEM
|
|||
celluloid-io (0.14.1)
|
||||
celluloid (>= 0.14.1)
|
||||
nio4r (>= 0.4.5)
|
||||
chef (11.4.4)
|
||||
erubis
|
||||
highline (>= 1.6.9)
|
||||
chef (11.8.2)
|
||||
chef-zero (~> 1.6, >= 1.6.2)
|
||||
diff-lcs (~> 1.2, >= 1.2.4)
|
||||
erubis (~> 2.7)
|
||||
highline (~> 1.6, >= 1.6.9)
|
||||
json (>= 1.4.4, <= 1.7.7)
|
||||
mixlib-authentication (>= 1.3.0)
|
||||
mixlib-cli (~> 1.3.0)
|
||||
mixlib-config (>= 1.1.2)
|
||||
mixlib-log (>= 1.3.0)
|
||||
mixlib-shellout
|
||||
mime-types (~> 1.16)
|
||||
mixlib-authentication (~> 1.3)
|
||||
mixlib-cli (~> 1.3)
|
||||
mixlib-config (~> 2.0)
|
||||
mixlib-log (~> 1.3)
|
||||
mixlib-shellout (~> 1.2)
|
||||
net-ssh (~> 2.6)
|
||||
net-ssh-multi (~> 1.1.0)
|
||||
ohai (>= 0.6.0)
|
||||
ohai (~> 6.0)
|
||||
pry (~> 0.9)
|
||||
puma (~> 1.6)
|
||||
rest-client (>= 1.0.4, < 1.7.0)
|
||||
yajl-ruby (~> 1.1)
|
||||
chefspec (3.0.2)
|
||||
chef-zero (1.7.2)
|
||||
hashie (~> 2.0)
|
||||
json
|
||||
mixlib-log (~> 1.3)
|
||||
moneta (< 0.7.0)
|
||||
rack
|
||||
chefspec (3.1.4)
|
||||
chef (~> 11.0)
|
||||
fauxhai (~> 2.0)
|
||||
i18n (>= 0.6.9, < 1.0.0)
|
||||
rspec (~> 2.14)
|
||||
chozo (0.6.1)
|
||||
activesupport (>= 3.2.0)
|
||||
hashie (>= 2.0.2)
|
||||
multi_json (>= 1.3.0)
|
||||
coderay (1.1.0)
|
||||
diff-lcs (1.2.5)
|
||||
erubis (2.7.0)
|
||||
faraday (0.8.8)
|
||||
multipart-post (~> 1.2.0)
|
||||
fauxhai (2.0.0)
|
||||
fauxhai (2.0.1)
|
||||
net-ssh
|
||||
ohai
|
||||
ffi (1.9.3)
|
||||
|
|
@ -92,14 +105,16 @@ GEM
|
|||
logging (1.8.1)
|
||||
little-plugger (>= 1.1.3)
|
||||
multi_json (>= 1.3.6)
|
||||
mime-types (2.0)
|
||||
method_source (0.8.2)
|
||||
mime-types (1.25.1)
|
||||
minitar (0.5.4)
|
||||
mixlib-authentication (1.3.0)
|
||||
mixlib-log
|
||||
mixlib-cli (1.3.0)
|
||||
mixlib-cli (1.4.0)
|
||||
mixlib-config (2.1.0)
|
||||
mixlib-log (1.6.0)
|
||||
mixlib-shellout (1.3.0)
|
||||
moneta (0.6.0)
|
||||
multi_json (1.8.2)
|
||||
multipart-post (1.2.0)
|
||||
net-http-persistent (2.9)
|
||||
|
|
@ -120,13 +135,19 @@ GEM
|
|||
mixlib-shellout
|
||||
systemu (~> 2.5.2)
|
||||
yajl-ruby
|
||||
parser (2.0.0)
|
||||
parser (2.1.2)
|
||||
ast (~> 1.1)
|
||||
slop (~> 3.4, >= 3.4.5)
|
||||
polyglot (0.3.3)
|
||||
powerpack (0.0.9)
|
||||
pry (0.9.12.4)
|
||||
coderay (~> 1.0)
|
||||
method_source (~> 0.8)
|
||||
slop (~> 3.4)
|
||||
puma (1.6.3)
|
||||
rack (~> 1.2)
|
||||
rack (1.5.2)
|
||||
rainbow (1.1.4)
|
||||
rainbow (1.99.1)
|
||||
rake (10.1.0)
|
||||
rbzip2 (0.2.0)
|
||||
rest-client (1.6.7)
|
||||
|
|
@ -160,8 +181,8 @@ GEM
|
|||
rspec-expectations (2.14.4)
|
||||
diff-lcs (>= 1.1.3, < 2.0)
|
||||
rspec-mocks (2.14.4)
|
||||
rubocop (0.15.0)
|
||||
parser (~> 2.0)
|
||||
rubocop (0.16.0)
|
||||
parser (~> 2.1)
|
||||
powerpack (~> 0.0.6)
|
||||
rainbow (>= 1.1.4)
|
||||
rubyntlm (0.1.1)
|
||||
|
|
@ -205,9 +226,9 @@ PLATFORMS
|
|||
|
||||
DEPENDENCIES
|
||||
berkshelf (~> 2.0.10)
|
||||
chef (~> 11.4.4)
|
||||
chefspec (~> 3.0.2)
|
||||
chef (~> 11.8)
|
||||
chefspec (~> 3.1.4)
|
||||
foodcritic (~> 3.0.3)
|
||||
json (<= 1.7.7)
|
||||
rubocop
|
||||
rubocop (>= 0.16.0)
|
||||
strainer
|
||||
|
|
|
|||
10
README.md
10
README.md
|
|
@ -74,15 +74,7 @@ None
|
|||
Testing
|
||||
=====
|
||||
|
||||
This cookbook uses [bundler](http://gembundler.com/), [berkshelf](http://berkshelf.com/), and [strainer](https://github.com/customink/strainer) to isolate dependencies and run tests.
|
||||
|
||||
Tests are defined in Strainerfile.
|
||||
|
||||
To run tests:
|
||||
|
||||
$ bundle install # install gem dependencies
|
||||
$ bundle exec berks install # install cookbook dependencies
|
||||
$ bundle exec strainer test # run tests
|
||||
Please refer to the [TESTING.md](TESTING.md) for instructions for testing the cookbook.
|
||||
|
||||
License and Author
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
# Strainerfile
|
||||
rubocop: bundle exec rubocop $SANDBOX/$COOKBOOK
|
||||
rubocop: bundle exec rubocop $SANDBOX/$COOKBOOK/Gemfile $SANDBOX/$COOKBOOK/metadata.rb --config $SANDBOX/$COOKBOOK/.rubocop.yml
|
||||
# rubocop: bundle exec rubocop $SANDBOX/$COOKBOOK
|
||||
knife test: bundle exec knife cookbook test $COOKBOOK
|
||||
foodcritic: bundle exec foodcritic -f any -t ~FC003 -t ~FC023 $SANDBOX/$COOKBOOK
|
||||
chefspec: bundle exec rspec $SANDBOX/$COOKBOOK/spec
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
# Testing the Cookbook #
|
||||
|
||||
This cookbook uses [bundler](http://gembundler.com/), [berkshelf](http://berkshelf.com/), and [strainer](https://github.com/customink/strainer) to isolate dependencies and run tests.
|
||||
|
||||
Tests are defined in [Strainerfile](Strainerfile), which in turn calls rubocop, knife, foodcritic and chefspec.
|
||||
|
||||
To run all of the tests with Strainer:
|
||||
|
||||
$ bundle exec strainer test -s Strainerfile
|
||||
|
||||
Or you may run the tests individually:
|
||||
|
||||
$ bundle install --path=.bundle # install gem dependencies
|
||||
$ bundle exec berks install --path=.cookbooks # install cookbook dependencies
|
||||
$ bundle exec strainer test -s Strainerfile # run tests
|
||||
|
||||
## Rubocop ##
|
||||
|
||||
[Rubocop](https://github.com/bbatsov/rubocop) is a static Ruby code analyzer, based on the community [Ruby style guide](https://github.com/bbatsov/ruby-style-guide). We are attempting to adhere to this where applicable, slowly cleaning up the cookbooks until we can turn on Rubocop for gating the commits.
|
||||
|
||||
### Attribute Rules ###
|
||||
|
||||
Since there are slight style differences between the coding of attributes, recipes and metadata files there are specific `.rubocop.yml` files for each of:
|
||||
|
||||
[Gemfile and metadata.rb](.rubocop.yml)
|
||||
[attributes/*.rb](attributes/.rubocop.yml)
|
||||
[recipes/.rubocop.yml](recipes/.rubocop.yml)
|
||||
[spec/.rubocop.yml](spec/.rubocop.yml)
|
||||
|
||||
## Knife ##
|
||||
|
||||
[knife cookbook test](http://docs.opscode.com/chef/knife.html#test) is used to check the cookbook's Ruby and ERB files for basic syntax errors.
|
||||
|
||||
## Foodcritic ##
|
||||
|
||||
[Foodcritic](http://acrmp.github.io/foodcritic/) is a lint tool for Chef cookbooks. We ignore the following rules:
|
||||
|
||||
[FC003](http://acrmp.github.io/foodcritic/#FC003) these cookbooks are not intended for Chef Solo.
|
||||
|
||||
## Chefspec
|
||||
|
||||
[ChefSpec](http://code.sethvargo.com/chefspec/) is a unit testing framework for testing Chef cookbooks. ChefSpec makes it easy to write examples and get fast feedback on cookbook changes without the need for virtual machines or cloud servers.
|
||||
48
metadata.rb
48
metadata.rb
|
|
@ -1,30 +1,30 @@
|
|||
name "openstack-ops-database"
|
||||
maintainer "Opscode, Inc."
|
||||
maintainer_email "matt@opscode.com"
|
||||
license "Apache 2.0"
|
||||
description "Provides the shared database configuration for Chef for OpenStack."
|
||||
version "8.0.0"
|
||||
name 'openstack-ops-database'
|
||||
maintainer 'Opscode, Inc.'
|
||||
maintainer_email 'matt@opscode.com'
|
||||
license 'Apache 2.0'
|
||||
description 'Provides the shared database configuration for Chef for OpenStack.'
|
||||
version '8.0.0'
|
||||
|
||||
recipe "client", "Installs client packages for the database used by the deployment."
|
||||
recipe "server", "Installs and configures server packages for the database used by the deployment."
|
||||
recipe "mysql-client", "Installs MySQL client packages."
|
||||
recipe "mysql-server", "Installs and configures MySQL server packages."
|
||||
recipe "postgresql-client", "Installs PostgreSQL client packages."
|
||||
recipe "postgresql-server", "Installs and configures PostgreSQL server packages."
|
||||
recipe "openstack-db", "Creates necessary tables, users, and grants for OpenStack."
|
||||
recipe 'client', 'Installs client packages for the database used by the deployment.'
|
||||
recipe 'server', 'Installs and configures server packages for the database used by the deployment.'
|
||||
recipe 'mysql-client', 'Installs MySQL client packages.'
|
||||
recipe 'mysql-server', 'Installs and configures MySQL server packages.'
|
||||
recipe 'postgresql-client', 'Installs PostgreSQL client packages.'
|
||||
recipe 'postgresql-server', 'Installs and configures PostgreSQL server packages.'
|
||||
recipe 'openstack-db', 'Creates necessary tables, users, and grants for OpenStack.'
|
||||
|
||||
%w{ fedora ubuntu redhat centos suse }.each do |os|
|
||||
supports os
|
||||
end
|
||||
|
||||
depends "database", ">= 1.4"
|
||||
depends "mysql", ">= 3.0.0"
|
||||
depends "openstack-block-storage", "~> 8.0"
|
||||
depends "openstack-common", "~> 8.0"
|
||||
depends "openstack-compute", "~> 8.0"
|
||||
depends "openstack-dashboard", "~> 8.0"
|
||||
depends "openstack-identity", "~> 8.0"
|
||||
depends "openstack-image", "~> 8.0"
|
||||
depends "openstack-metering", "~> 8.0"
|
||||
depends "openstack-network", "~> 8.0"
|
||||
depends "postgresql", ">= 3.0.0"
|
||||
depends 'database', '>= 1.4'
|
||||
depends 'mysql', '>= 3.0.0'
|
||||
depends 'openstack-block-storage', '~> 8.0'
|
||||
depends 'openstack-common', '~> 8.0'
|
||||
depends 'openstack-compute', '~> 8.0'
|
||||
depends 'openstack-dashboard', '~> 8.0'
|
||||
depends 'openstack-identity', '~> 8.0'
|
||||
depends 'openstack-image', '~> 8.0'
|
||||
depends 'openstack-metering', '~> 8.0'
|
||||
depends 'openstack-network', '~> 8.0'
|
||||
depends 'postgresql', '>= 3.0.0'
|
||||
|
|
|
|||
Loading…
Reference in New Issue