fulmar-plugin-mariadb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e7b3dd0c3c2da8c79a9155f10a2babe8091bb30
+  data.tar.gz: 0630e38e31fa451a440597c4413ce8219eb2236e
+SHA512:
+  metadata.gz: 1f57085d8d7274ee60f03d12a00d794a555f260acc85b84fce9de52c4cf60817938ee717b6e699ad390f0330862095dc090887736b1df0339e5354b5d8ec8401
+  data.tar.gz: 3d6dd720b9f91609c03c3210a5c68853c65c03fb236c138bd64d2dbdbe8d78c16069ed122eccf64351fb97c942f0dcaa5747615cd97870d82b2e5e2d1c949dc2

data/.gitignore

@@ -0,0 +1,11 @@
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fulmar-plugin-example.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gerrit Visscher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Fulmar::Plugin::MariaDB
+
+This plugin adds a mariadb method to fulmar tasks. You can only run simple queries without return values to create
+a database for example. The main use case for this is to create / load sql dumps.
+
+Please feel free to ask for help.
+
+## Prerequisites
+
+This plugin needs the mysql client to be installed.
+
+## Installation
+
+This plugin will be installable via gem install `fulmar-plugin-mariadb` when it is working. It will need Fulmar 2.
+You can also checkout this repo and run `gem build fulmar-plugin-mariadb.gemspec` and
+`gem install fulmar-plugin-mariadb*.gem`
+
+## Usage
+
+Add the plugin to your config.yml of the project:
+
+```yaml
+plugins:
+  mariadb:
+```
+
+And add a configuration to either an environment or a host:
+
+```yaml
+environments:
+  live:
+    cms:
+      mariadb:
+        host: 127.0.0.1
+        user: cms_user
+        password: password
+        database: cms_db_1
+```
+
+You can use the [.my.cnf](https://easyengine.io/tutorials/mysql/mycnf-preference/) file if you don't want to put
+your database credentials into the config.
+
+```ruby
+task :database => 'environment:staging:database' do
+  database.query 'UPDATE settings SET value="http://dev-project.local" WHERE name="url"'
+  remote_file_name = database.dump # dumps the database to the returned file
+  database.load_dump(remote_file_name) # loads an sql dump
+  local_filename = database.download_dump # downloads an sql dump to your machine
+```
+
+## Syncing
+
+If you configured more than one database on different environments, fulmar will
+create task to sync these databases via mysql_dump. This allows you to update a
+staging or preview database with the data from the production system.
+
+```
+fulmar database:update:preview:from_live
+```
+
+The task to copy data *to* the live database is hidden (it has no description).
+
+
+## Limitations
+
+You can not use SELECT or other queries that return data.
+
+Query cannot contain single quotes at the moment. This is due to the queries beeing passed to the mysql shell client
+and escaping does not work correctly then. So you should avoid running complex queries with this fulmar plugin. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CORE4/fulmar-plugin-mariadb.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+
+
+### Database access
+
+Within a task you can access and update databases (mariadb/mysql at the time of writing). Remote databases do not need
+to be accessible directly since fulmar uses an ssh tunnel to connect to the host first. So the database host is often
+just "localhost" (the default value). You can specify a different host if you database server is on another host, which
+is the case on most simple web spaces.
+
+The field "maria:database" is required. The other fields are optional. You can use the file `.my.cnf`
+to specify the password only on the host itself and not have it in your deployment code.
+
+```yaml
+environments:
+  staging:
+    database:
+      host: project-staging
+      type: maria
+      mariadb:
+        database: db_name
+        user: root
+        password:
+        port: 3306
+        host: localhost
+        encoding: utf-8
+```
+
+
+end
+
+You can query the database like this:
+
+
+
+You can use all features of the mysql2 gem via `database.client`.
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fulmar-plugin-mariadb.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fulmar/plugin/mariadb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fulmar-plugin-mariadb'
+  spec.version       = Fulmar::Plugin::MariaDB::VERSION
+  spec.authors       = ['Gerrit Visscher']
+  spec.email         = ['g.visscher@core4.de']
+
+  spec.summary       = 'MariaDB database plugin for fulmar'
+  spec.description   = 'This gems add database handling'
+  spec.homepage      = 'https://github.com/CORE4/fulmar-plugin-mariadb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/}) || %w(.editorconfig).include?(f)
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fulmar', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/fulmar/plugin/mariadb/configuration.rb

@@ -0,0 +1,19 @@
+require 'fulmar/plugin/mariadb/version'
+require 'fulmar/plugin/mariadb/dsl_helper'
+require 'fulmar/plugin/mariadb/database'
+
+module Fulmar
+  module Plugin
+    module MariaDB
+      class Configuration
+        def initialize(config)
+          @config = config
+        end
+
+        def rake_files
+          Dir.glob(File.dirname(__FILE__)+'/rake/*.rake')
+        end
+      end
+    end
+  end
+end

data/lib/fulmar/plugin/mariadb/database.rb

@@ -0,0 +1,119 @@
+require 'fulmar/shell'
+
+module Fulmar
+  module Plugin
+    module MariaDB
+      # Provides basic methods common to all database services
+      class Database
+        attr_reader :shell, :local_shell
+
+        DEFAULT_CONFIG = {
+          mariadb: {
+            host: '127.0.0.1',
+            port: 3306,
+            user: 'root',
+            password: '',
+            encoding: 'utf8',
+            ignore_tables: [],
+            diffable_dump: false,
+            dump_path: '/tmp'
+          }
+        }
+
+        def initialize(config, shell = initialize_shell, local_shell = nil)
+          @config = config
+          @config.merge DEFAULT_CONFIG
+          @shell = shell
+          @local_shell = local_shell || Fulmar::Shell.new(@config[:mariadb][:dump_path])
+          @local_shell.debug = true if config[:debug] # do not deactivate debug mode is shell set it explicitly
+          config_test
+        end
+
+        def create(name, user = nil, password = nil, host = 'localhost')
+          query "CREATE DATABASE IF NOT EXISTS `#{name}`"
+          if user
+            password_sql = password ? " IDENTIFIED BY \"#{password}\"" : ''
+            query "GRANT ALL ON `#{name}`.* TO #{user}@#{host}#{password_sql}"
+          end
+        end
+
+        def query(sql_query)
+          if sql_query.include?('\'')
+            fail 'This fulmar plugin currently does no support queries with single quotes to the simple '\
+                 " quoting in fulmar shell. Query was: #{sql_query}"
+          end
+
+          @shell.run "#{command('mysql')} -D '#{@config[:mariadb][:database]}' -e '#{sql_query}'"
+        end
+
+        # Add parameters like host, user, and password to the base command like mysql or mysqldump
+        def command(binary)
+          command = binary
+          command << " -h #{@config[:mariadb][:host]}" unless @config[:mariadb][:host].blank?
+          command << " -u #{@config[:mariadb][:user]}" unless @config[:mariadb][:user].blank?
+          command << " --password='#{@config[:mariadb][:password]}'" unless @config[:mariadb][:password].blank?
+          command
+        end
+
+        def dump(filename = backup_filename)
+          filename = "#{@config[:mariadb][:dump_path]}/#{filename}" unless filename[0, 1] == '/'
+          @shell.run "#{dump_command} -r \"#{filename}\""
+          filename
+        end
+
+        def load_dump(dump_file, database = @config[:mariadb][:database])
+          if File.extname(dump_file) == '.gz'
+            @shell.run "cat #{dump_file} | gzip -d | #{command('mysql')} -D #{database}"
+          else
+            @shell.run "#{command('mysql')} -D #{database} < #{dump_file}"
+          end
+        end
+
+        def download_dump(filename = "#{backup_filename}.gz")
+          local_path = filename[0, 1] == '/' ? filename : "#{@config[:mariadb][:dump_path]}/#{filename}"
+          remote_command = "#{dump_command} | gzip"
+          @local_shell.run "ssh #{@config.ssh_user_and_host} \"#{remote_command}\" > #{local_path}"
+          local_path
+        end
+
+        protected
+
+        def dump_command
+          "#{command('mysqldump')} #{@config[:mariadb][:database]} --single-transaction #{diffable} #{ignore_tables}"
+        end
+
+        # Return mysql command line options to ignore specific tables
+        def ignore_tables
+          @config[:mariadb][:ignore_tables] = [*@config[:mariadb][:ignore_tables]]
+          @config[:mariadb][:ignore_tables].map do |table|
+            "--ignore-table=#{@config[:mariadb][:database]}.#{table}"
+          end.join(' ')
+        end
+
+        # Return the mysql configuration options to make a dump diffable
+        def diffable
+          @config[:mariadb][:diffable_dump] ? '--skip-comments --skip-extended-insert ' : ''
+        end
+
+        # Test configuration
+        def config_test
+          fail 'Configuration option "database" missing.' unless @config[:mariadb][:database]
+        end
+
+        # Builds the filename for a new database backup file
+        # NOTE: The file might already exist, for example if this is run at the same
+        # time from to different clients. I won't handle this as it is unlikely and
+        # would result in more I/O
+        def backup_filename
+          "#{@config[:mariadb][:database]}_#{Time.now.strftime('%Y-%m-%dT%H%M%S')}.sql"
+        end
+
+        def initialize_shell
+          @shell = Fulmar::Shell.new(@config[:mariadb][:dump_path], @config.ssh_user_and_host)
+          @shell.debug = true if @config[:debug]
+          @shell.strict = true
+        end
+      end
+    end
+  end
+end

data/lib/fulmar/plugin/mariadb/dsl_helper.rb

@@ -0,0 +1,13 @@
+module Fulmar
+  module Plugin
+    module MariaDB
+      module DslHelper
+        # Return a mariadb object to query the database or get dumps
+        def mariadb
+          shell = config[:hostname] && config[:hostname] != 'localhost' ? remote_shell : local_shell
+          storage['mariadb'] ||= Fulmar::Plugin::MariaDB::Database.new config, shell, local_shell
+        end
+      end
+    end
+  end
+end

data/lib/fulmar/plugin/mariadb/rake/database_sync.rake

@@ -0,0 +1,73 @@
+db_configs = []
+config.each do |env, target, data|
+  db_configs << [env, target] unless data[:mariadb].nil? || data[:mariadb][:database].nil?
+end
+
+# Expects two hashes as parameters each with { :environment, :target, :name } set
+# :name is either environment:target or just the environment, if the is only one target
+def create_update_task(from, to)
+  namespace to[:name] do
+    task "from_#{from[:name]}" do
+      # Add a bit of security
+      if %w(live prod production).include?(to[:environment]) && !ARGV.include?('--force')
+        ARGV.reject! { |param| param == '--force' }
+        warning 'You are about to update the live database from another source.'
+        print 'Are you sure? [y/N] '
+        answer = STDIN.gets
+        exit if answer.downcase != 'y'
+      end
+
+      config.set(from[:environment], from[:target])
+      info 'Getting dump...'
+      sql_dump = mariadb.download_dump
+      if sql_dump == ''
+        error 'Cannot create sql dump'
+      else
+        config.set(to[:environment], to[:target])
+        info 'Sending dump...'
+        dump_path = config[:mariadb][:dump_path] ||
+          Fulmar::Plugin::MariaDB::Database::DEFAULT_CONFIG[:mariadb][:dump_path]
+        remote_sql_dump = upload(sql_dump, dump_path)
+        mariadb.load_dump(remote_sql_dump)
+      end
+    end
+  end
+end
+
+def name(env, target, counts)
+  (counts[env] <= 1 || target.nil?) ? env : "#{env}:#{target}"
+end
+
+def create_update_tasks(db_configs)
+  counts = {}
+  db_configs.each do |config|
+    counts[config.first] = 0 unless counts[config.first]
+    counts[config.first] += 1
+  end
+
+  namespace :database do
+    db_configs.each do |from_db|
+      db_configs.each do |to_db|
+        next if from_db == to_db # no need to sync a database to itself
+        next if from_db.last != to_db.last # sync only matching target names
+        from = {
+          environment: from_db.first,
+          target: from_db.last,
+          name: name(from_db.first, nil, counts)
+        }
+        to = {
+          environment: to_db.first,
+          target: to_db.last,
+          name: name(to_db.first, to_db.last, counts)
+        }
+        create_update_task(from, to)
+      end
+    end
+  end
+end
+
+if db_configs.any?
+  namespace :update do
+    create_update_tasks(db_configs) if db_configs.count > 1
+  end
+end

data/lib/fulmar/plugin/mariadb/version.rb

@@ -0,0 +1,7 @@
+module Fulmar
+  module Plugin
+    module MariaDB
+      VERSION = '0.2.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fulmar-plugin-mariadb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Gerrit Visscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fulmar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gems add database handling
+email:
+- g.visscher@core4.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fulmar-plugin-mariadb.gemspec
+- lib/fulmar/plugin/mariadb/configuration.rb
+- lib/fulmar/plugin/mariadb/database.rb
+- lib/fulmar/plugin/mariadb/dsl_helper.rb
+- lib/fulmar/plugin/mariadb/rake/database_sync.rake
+- lib/fulmar/plugin/mariadb/version.rb
+homepage: https://github.com/CORE4/fulmar-plugin-mariadb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: MariaDB database plugin for fulmar
+test_files: []