chbuild 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66317c7b76fd467dd5b6506a9a2e5b5cb77a2d5c
+  data.tar.gz: 599e67c26453942029511828b2154e155f20bff0
+SHA512:
+  metadata.gz: 6f41562f0add9e39659440ad43a8c31f258a0e4bb82269bed0c8cc4b96334110d0232675dab70fe270f7e4d9d0a69e76ac582ab343f337371c3753830030fae0
+  data.tar.gz: 13f5d4ffe2a64ce182488043d597317148f0a774e4a7174f707a3b9e5d928fbb4ed83a34fa322c8d4e6f019d4281a834646c3133d3e4749c9f81c976b7a1d784

data/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown,md}]
+indent_size = 4
+
+[*.{markdown,md}]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/webroot/
+/iniscripts/
+.chbuild.yml
+.chbuild.yaml
+erl_crash.dump

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'templates/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 50

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This CHANGELOG follows [Keep a CHANGELOG](http://keepachangelog.com/).
+
+## [0.0.1] - 2016-10-20
+### First open-source release
+
+## [0.0.1] - 2016-10-10
+### First internal release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gabor.takacs@cheppers.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chbuild.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Cheppers Ltd. <info@cheppers.com>
+
+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,152 @@
+# chbuild
+chbuild is an open-source command line application written in Ruby. It's main purpose is to simplify web app development by running a site using Docker containers so you don't have to install Apache, PHP and PHP extensions on your own machine.
+
+## Requirements
+* Ruby 2.3.0+
+* Docker (for Mac see [this](https://docs.docker.com/engine/installation/mac/#/docker-for-mac))
+
+## Installation
+1. Install requirements (see above)
+2. `gem install chbuild`
+
+## Usage
+1. Create a `.chbuild.yml` file in the root of your repository
+2. Launch docker
+3. Run `$ chbuild start` to build the image, launch the MySQL container and the chbuild container
+4. Run `$ chbuild restart` to restart the chbuild container
+
+When you run the `start` command the following will happen:
+
+1. chbuild builds a docker image with apache, php-fpm and a couple of PHP extensions and configure them to work together
+2. chbuild downloads and starts a MySQL container (of your choice or the latest one if undefined in the YAML)
+3. chbuild starts the chbuild container
+4. chbuild runs the init script
+5. You can access the site on `localhost:8088`
+6. If your root directory is empty chbuild will create an index.php file with a phpinfo inside
+
+When you run the `restart` command the following will happen:
+
+1. chbuild checks if your image is up-to-date and builds a new one if needed
+2. chbuild kills the currently running chbuild container
+3. chbuild starts a new container and reruns the init script 
+
+## The container
+The following happens in the container when you start it:
+
+1. Export the specified envrionment variables (`env` section)
+2. Runs the commands from the `before` section
+3. Starts apache
+4. Starts php-fpm to keep alive the container
+
+## The .chbuild.yml
+The build file consists of sections: `version`, `use`, `before`, `env`.
+The minimal YAML file for chbuild to work properly:
+```yaml
+---
+version: 1.0
+```
+
+## Sections of the build file
+### version - [required]
+Version of the build file. Currently this is the only required section. 
+
+Allowed values: `1.0`
+
+**Example**
+```yaml
+---
+version: 1.0
+```
+
+### use - [optional]
+Specify the MySQL and PHP versions you want to use.
+
+#### PHP
+Current default PHP version: **5.6.25**
+
+At the moment specifying a PHP version is not working (to be implemented soon).
+
+#### MySQL 
+Default is the latest from Dockerhub
+
+To connect:
+
+* no username
+* password is 'admin'
+* host address: $MYSQL_PORT_3306_TCP_ADDR
+
+**Example**
+```yaml
+---
+version: 1.0
+use:
+  mysql: 5.6.20
+```
+
+### env - [optional]
+Specify environment variables to use them in the `before` script or in your site
+
+**Example**
+```yaml
+---
+version: 1.0
+env:
+  THE_ANSWER: 42
+  DOCTOR: Who
+```
+
+### before - [optional]
+Run scrips before starting php-fpm.
+
+**Example**
+```yaml
+---
+version: 1.0
+before:
+  - composer install
+```
+
+## Example .chbuild.yml
+```yaml
+---
+version: 1.0
+use:
+  mysql: 5.6.20
+env:
+  YAML_DEFINED: envvar
+  ANOTHER_ENV_VAR: CHBuild
+before:
+  - echo "Hello, $ANOTHER_ENV_VAR!<br />Generated at $(date)<br /> MySQL version $MYSQL_ENV_MYSQL_VERSION" > /www/index.php
+```
+
+## Commands
+```bash
+$ chbuild help
+Commands:
+  chbuild --version, -V          # Current version
+  chbuild delete [-CIM]  # Delete container, image or MySQL container(s)
+  chbuild help [COMMAND]         # Describe available commands or one specific command
+  chbuild log                    # Get container log
+  chbuild restart                # Restart chbuild container
+  chbuild start                  # Build and start everything
+  chbuild validate               # Validate build definition file
+
+Options:
+  -v, [--verbose], [--no-verbose]
+  -f, [--force]
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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
+1. Fork the repo
+2. Commit your changes to your own repo on a separate branch
+3. Submit pull request
+
+If you can, please use the provided [EditorConfig](http://editorconfig.org/) file!
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). See more in LICENSE.txt

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/chbuild

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'chbuild'
+require 'colorize'
+require 'pp'
+require 'thor'
+
+# rubocop:disable Metrics/AbcSize, Metrics/ClassLength
+# CHBuild CLI
+class CHBuildCLI < Thor
+  no_commands do
+    def build_image(options: {})
+      if CHBuild::Controller.image_exist?
+        puts 'Image already exists, skipping image build' if options[:verbose]
+        return
+      end
+      if options[:verbose]
+        CHBuild::Controller.build { |message| puts message }
+      else
+        start = Time.now
+        CHBuild::Controller.build do |message|
+          message.match(/step \d{1,2}/i) do |match|
+            num = match.to_s.split[1].to_i
+            step = '['.green + "#{(Time.now - start).round(2)}s".rjust(6) + ']'.green
+            text = "Building your image#{'.' * num}".green
+            print "#{step} #{text}\r"
+            $stdout.flush
+          end
+        end
+      end
+      print "\n"
+      $stdout.flush
+      puts 'Image build successfully'.green
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def run_container(restart: false, options: {})
+      if (c = CHBuild::Controller.container?) && restart
+        CHBuild::Controller.delete_container
+        puts 'Container killed'.green
+      elsif c
+        puts "Container already exists, run 'chbuild restart' to relaunch it" if options[:verbose]
+        return
+      end
+
+      controller_run = CHBuild::Controller.run(webroot: Dir.pwd) do |log|
+        puts log if options[:verbose]
+      end
+
+      unless controller_run
+        puts 'Could not start container :('.red
+        exit 1
+      end
+
+      puts 'Container started'.green
+      puts "Container id: #{CHBuild::Controller.container_id}" if options[:verbose]
+    end
+
+    def delete_mysql_containers
+      if CHBuild::Controller.delete_mysql_containers
+        'MySQL container(s) killed'.green
+      else
+        'MySQL container(s) not found'.yellow
+      end
+    end
+
+    def delete_image
+      if CHBuild::Controller.delete_image
+        'Image deleted'.green
+      else
+        'Image not found'.yellow
+      end
+    end
+
+    def delete_container
+      if CHBuild::Controller.delete_container
+        'Container killed'.green
+      else
+        'Container not found'.yellow
+      end
+    end
+  end
+
+  class_option :verbose, type: :boolean, aliases: '-v'
+  class_option :force, type: :boolean, aliases: '-f'
+
+  map %w(--version -V) => :__print_version
+  desc '--version, -V', 'Current version'
+  def __print_version
+    puts CHBuild::VERSION
+  end
+
+  desc 'start', 'Build and start everything'
+  def start
+    build_image(options: options)
+
+    run_container(options: options)
+
+    puts "Build environment up and running; run 'chbuild restart' to relaunch container".green
+  end
+
+  desc 'restart', 'Restart chbuild container'
+  def restart
+    build_image(options: options)
+
+    run_container(restart: true, options: options)
+
+    puts "Build environment up and running; run 'chbuild restart' to relaunch container".green
+  end
+
+  desc 'log', 'Get container log'
+  def log
+    puts CHBuild::Controller.container_logs
+  end
+
+  desc 'delete [-C] [-I] [-M]', 'Delete container, image or MySQL container(s)'
+  method_option :container, aliases: '-C', type: :boolean, default: false, desc: 'Delete container'
+  method_option :image, aliases: '-I', type: :boolean, default: false, desc: 'Delete image'
+  method_option 'mysql-container',
+                aliases: '-M',
+                type: :boolean,
+                default: false,
+                desc: 'Delete MySQL container(s)'
+  def delete
+    puts delete_container if options[:container]
+
+    puts delete_image if options[:image]
+
+    puts delete_mysql_containers if options['mysql-container']
+
+  rescue => e
+    puts e.message.red
+    exit 1
+  end
+
+  desc 'validate', 'Validate build definition file'
+  method_option :path,
+                aliases: '-p',
+                default: File.join(Dir.pwd, '.chbuild.yml'),
+                desc: 'Build definition file path'
+  def validate
+    config = CHBuild::Controller.config(options[:path])
+
+    puts "Config path: #{config.path}".green
+
+    if options[:verbose]
+      puts 'Config from file:'.yellow
+      pp config.raw
+      puts 'Final config:'.yellow
+      pp config
+    end
+
+    if config.errors.length.zero?
+      puts 'Looks good'.green
+      return
+    end
+
+    puts "Errors:\n".red
+    config.errors.each do |err|
+      puts err.red
+    end
+    exit 1
+  end
+end
+
+CHBuildCLI.start(ARGV)