ansible_module 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6355d7da66ac0cb19bc372a9733fba816217b87
-  data.tar.gz: 4f34188771a2276f2397609b3540cabcb79c55cd
+  metadata.gz: cf1b28c2d28267e752955d791b48e7b2a1f90789
+  data.tar.gz: fcc36bebf0600969dd4fbdc437a83bf38365c6ca
 SHA512:
-  metadata.gz: ab78c4fb84571570587976d59dfbf3a3ad9f076d2b8fe61210ecf94ba6cf81b067118dd9dc88d6ff6c5e48d29cb29a8203fc564ec0f84a20d0c5c683ece8400a
-  data.tar.gz: ed41b1780a6439bfff9a3fe88d0418b5d42887380814af2be2efa9ba11ef9c10270599843b6df554d90dc51a744852fb6e9a9fb0fad67cf785c26d9da59e58af
+  metadata.gz: acfff12953c0ae8c0841c0d7a74cfed39d86ba90f5b83657cc77c913e34f433aa7c652b8b9839c545d3c97500198513ab694a8ef5a04d94f0af0f888ee52eb9d
+  data.tar.gz: 645ebb33640f937a8ee3b3fc7df4ec4f3c2c33704527bd6d69da3699bee1ee6ce6cdb9b96b20e5741cde7609d8a506dbe9ac93acd46f344197dad1286bee154f

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+## 0.9.2 (2014-08-31)
+
+* Add initial RSpec examples.
+
 ## 0.9.1 (2014-08-28)
 
 * Add private method `AnsibleModule#invalid_json` to improve the message on

data/README.md

@@ -19,7 +19,7 @@ The following is a typical procedure on Ubuntu Server 14.04:
 ```
 $ sudo add-apt-repository -y ppa:brightbox/ruby-ng
 $ sudo apt-get update
-$ sudo apt-get -y install ruby2.1
+$ sudo apt-get -y install ruby2.1 ruby2.1-dev
 $ sudo gem install ansible_module
 ```
 
@@ -37,6 +37,8 @@ The following is an example for Ubuntu Server 14.04:
     apt_repository: repo='ppa:brightbox/ruby-ng' state=present
   - name: Install ruby 2.1
     apt: name=ruby2.1 state=present
+  - name: Install ruby 2.1 headers
+    apt: name=ruby2.1-dev state=present
   - name: Install ansible_module gem
     gem: name=ansible_module user_install=false state=present
 ```
@@ -50,8 +52,10 @@ $ ansible-playbook -i hosts ruby_environment.yml
 In the above example, the `hosts` file is an [inventory](http://docs.ansible.com/intro_inventory.html) which lists up host names or IP addresses.
 
 
-Example (1)
------------
+Example (1) -- Simple Calculation
+---------------------------------
+
+### Module
 
 Create a file named `calc` on the `library` directory as follows:
 
@@ -62,10 +66,9 @@ require 'ansible_module'
 
 class Calc < AnsibleModule
   attribute :x, Integer
-  attribute :y, Integer, default: 100
+  attribute :y, Integer
 
-  validates :x, presence: true, numericality: { only_integer: true }
-  validates :y, numericality: { only_integer: true }
+  validates :x, :y, presence: true, numericality: { only_integer: true }
 
   def main
     sum = x + y
@@ -81,7 +84,16 @@ The values of attributes `x` and `y` are set during instantiation process by `An
 
 Note that you can validate them with `validates` class method derived from `ActiveModel`.
 
-Then, create a file named `calc.yml` as follows:
+The class method `instance` returns a singleton instance of `Calc` class,
+and its `run` method calls the `main` method if validations are successful.
+
+So, the author of an Ansible module must implement the `main` method at least.
+
+
+### Playbook
+
+Now, you can use the `calc` module in your playbook.
+For example, create a file named `calc.yml` as follows:
 
 ```yaml
 - hosts: servers
@@ -89,19 +101,52 @@ Then, create a file named `calc.yml` as follows:
   - name: Make a calculation
     calc: x=50 y=50
     register: result
-  - debug: >
-      msg="sum = {{ result['sum'] }}"
+  - debug: msg="sum = {{ result['sum'] }}"
 ```
 
-And run the following command on your local host:
+Then, run the following command on your local host:
 
 ```
 $ ansible-playbook -i hosts calc.yml
 ```
 
 
-Example (2)
------------
+Example (2) -- MySQL 5.6 Replication Management
+-----------------------------------------------
+
+### Prerequisites
+
+Install MySQL 5.6 Server, MySQL 5.6 Client, MySQL 5.6 development files and `mysql2` gem.
+
+The following is a typical procedure on Ubuntu Server 14.04:
+
+```
+$ sudo add-apt-repository -y ppa:ondrej/mysql-5.6
+$ sudo apt-get update
+$ sudo apt-get -y install mysql-server-5.6 mysql-client-5.6 libmysqlclient-dev
+$ sudo gem install mysql2
+```
+
+You can also install them with the following playbook:
+
+```yaml
+- hosts: servers
+  sudo: yes
+  tasks:
+  - name: Add ppa for mysql 5.6
+    apt_repository: repo='ppa:ondrej/mysql-5.6' state=present
+  - name: Install mysql server 5.6
+    apt: name=mysql-server-5.6 state=present
+  - name: Install mysql client 5.6
+    apt: name=mysql-client-5.6 state=present
+  - name: Install libmysqlclient-dev
+    apt: name=libmysqlclient-dev state=present
+  - name: Install mysql2 gem
+    gem: name=mysql2 user_install=false state=present
+```
+
+
+### Module
 
 Create a file named `mysql_change_master` on the `library` directory as follows:
 
@@ -109,6 +154,7 @@ Create a file named `mysql_change_master` on the `library` directory as follows:
 #!/usr/bin/ruby
 
 require 'ansible_module'
+require 'mysql2'
 
 class MysqlChangeMaster < AnsibleModule
   attribute :host, String
@@ -117,28 +163,59 @@ class MysqlChangeMaster < AnsibleModule
   attribute :password, String
   attribute :mysql_root_password, String
 
+  validates :host, :user, :password, presence: true
   validates :port, inclusion: { in: 0..65535 }
+  validates :password, maximum: 32
 
   def main
+    done? && exit_json(changed: false)
+
     statement = %Q{
-      STOP SLAVE;
       CHANGE MASTER TO
         MASTER_HOST='#{host}',
         MASTER_PORT=#{port},
         MASTER_USER='#{user}',
         MASTER_PASSWORD='#{password}',
-        MASTER_AUTO_POSITION=1;
-      START SLAVE;
+        MASTER_AUTO_POSITION=1
     }.squish
 
-    command = %Q{
-      /usr/bin/mysql -u root -p#{mysql_root_password} -e "#{statement}"
-    }.squish
+    mysql_client.query('STOP SLAVE')
+    mysql_client.query(statement)
+    mysql_client.query('START SLAVE')
+    sleep(1)
 
-    system(command)
-
-    exit_json(statement: statement, changed: true)
+    if done?
+      exit_json(statement: statement, changed: true)
+    else
+      fail_json(msg: "Last Error: #{@last_error}")
+    end
   end
+
+  private
+
+    def done?
+      status = mysql_client.query('SHOW SLAVE STATUS').first || {}
+
+      @last_error = [ status['Last_IO_Error'], status['Last_SQL_Error'] ]
+        .compact.join(' ').squish
+
+      status['Master_Host'] == host &&
+        status['Master_User'] == user &&
+        status['Master_Port'].to_i == port &&
+        status['Auto_Position'].to_i == 1 &&
+        status['Slave_IO_State'] != '' &&
+        status['Last_IO_Error'] == '' &&
+        status['Last_SQL_Error'] == ''
+    end
+
+    def mysql_client
+      @client ||= Mysql2::Client.new(
+        host: 'localhost',
+        username: 'root',
+        password: mysql_root_password,
+        encoding: 'utf8'
+      )
+    end
 end
 
 MysqlChangeMaster.instance.run
@@ -146,6 +223,8 @@ MysqlChangeMaster.instance.run
 
 Note that you can use methods added by `ActiveSupport` like `String#squish`.
 
+### Playbook
+
 Then, create a file named `replication.yml` as follows:
 
 ```yaml

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.9.2

data/lib/ansible_module.rb

@@ -24,30 +24,29 @@ class AnsibleModule
 
   private
 
-  def exit_json(hash)
-    hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
-    print JSON.dump(hash)
-    exit 0
-  end
+    def exit_json(hash)
+      hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
+      print JSON.dump(hash)
+      exit 0
+    end
 
-  def fail_json(hash)
-    hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
-    hash[:failed] = true
-    hash[:msg] ||= "No error message."
-    print JSON.dump(hash)
-    exit 1
-  end
+    def fail_json(hash)
+      hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
+      hash[:failed] = true
+      hash[:msg] ||= "No error message."
+      print JSON.dump(hash)
+      exit 1
+    end
 
-  def invalid_json
-    message = 'Invalid parameters: '
-    message += errors.full_messages.map { |m| "#{m}." }.join(' ')
-    fail_json(msg: message)
-  end
+    def invalid_json
+      message = 'Invalid parameters: '
+      message += errors.full_messages.map { |m| "#{m}." }.join(' ')
+      fail_json(msg: message)
+    end
 
   class << self
     def instance
       @instance ||= new(params)
-      @instance
     end
 
     def params

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible_module
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Tsutomu KURODA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: AnsibleModule is a Ruby class that provides basic functionalities as
   an Ansible module.
 email: t-kuroda@oiax.jp
@@ -101,5 +115,5 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: AnsibleModule class for Ruby language.
+summary: A Ruby base class for Ansible module.
 test_files: []