devup 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3111015b0f138014ede5086a6df15c4e3e4f1b30d1bd7a199ec16a69b7eb84e
-  data.tar.gz: afab2b2376b8137be5bbbc2a3f85d3464720f63312d1a7cefbc948abbf07168d
+  metadata.gz: 99a6b3579f7d44d86a42c61b5d5b55dcd32e8d7aac580c49e5bce9a95500ff02
+  data.tar.gz: 2a73831a4d8d1549d6150050c12d4806ab8cc41089cbb9ce2b81420d09b02c8a
 SHA512:
-  metadata.gz: 58a825f460fce341d66aa22e3b6c257c920908967a1ae64a207f274ebf051144cfba56a19e526e8555c5061d4f2bc37b14ae86bafc3f03a35315352d78aa98ee
-  data.tar.gz: c6897be6a6378476b21e65a0a7d59402641658a400bbc20b655f234d19ab5144e5d23b2bdd764558248519c63fdfc81eee7951c17bcadd779d4c2104377df091
+  metadata.gz: 709e5c38a2786273085eba92ab0fa70f70dd8fbbfe1200b631ab1bd527b072df097fe6b856bab1e57a5790952dd2476665bcca965e302a69fa8ea2d47cb0d2a4
+  data.tar.gz: 5c81a935db87d41f22be697fcce631d9f80262f155bbc5eac146c2782e8d1ff49a4a805a86ad0b2c14b3d91e118807c80e0f857ba8584927a1743eab3fd7d87a

data/.gitignore

@@ -14,6 +14,7 @@
 # Editor config
 .vimrc
 
+.env.services
 spec/dummy/.env.services
 spec/dummy_rails/.env.services
 

data/Gemfile

@@ -8,3 +8,4 @@ gem "rspec", "~> 3.0"
 gem "standard"
 gem "simplecov", require: false
 gem "byebug"
+gem "lefthook"

data/Gemfile.lock

@@ -1,19 +1,24 @@
 PATH
   remote: .
   specs:
-    devup (0.3.0)
+    devup (0.4.0)
       dotenv
+      dry-cli
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     byebug (11.1.3)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     docile (1.3.2)
     dotenv (2.7.5)
+    dry-cli (0.6.0)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     json (2.3.0)
+    lefthook (0.7.2)
     parallel (1.19.1)
     parser (2.7.1.0)
       ast (~> 2.4.0)
@@ -60,6 +65,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   devup!
+  lefthook
   rake (~> 12.0)
   rspec (~> 3.0)
   simplecov

data/README.md

@@ -1,4 +1,4 @@
-# DevUp!  [![Travis (.com) branch](https://img.shields.io/travis/com/sergio-fry/devup/master)](https://travis-ci.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/v/devup)](https://rubygems.org/gems/devup) [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/dt/devup)](https://rubygems.org/gems/devup)
+# DevUp!  [![Travis (.com) branch](https://img.shields.io/travis/com/sergio-fry/devup/master)](https://travis-ci.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/v/devup)](https://rubygems.org/gems/devup) [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/dt/devup)](https://rubygems.org/gems/devup) [![Hits-of-Code](https://hitsofcode.com/github/sergio-fry/devup)](https://hitsofcode.com/view/github/sergio-fry/devup)
 
 Describe development dependencies with docker-compose. It is not required to remember any fancy command to start docker. Just start developing your app. Rails is a first-class citizen, but could be used without ruby.
 
@@ -32,7 +32,7 @@ gem "devup", group: [:development, :test]
 
 and
 
-    bundle install
+    $ bundle install
 
 
 Update your database.yml to use ENV:
@@ -49,11 +49,11 @@ development:
 
 You are ready to use rails with PostgreSQL configured
 
-    $ bundle exec rake db:create db:migrate
-    Creating blog_postgres_1 ... done
-    Created database 'blog_development'
+    $ RAILS_ENV=test bundle exec rake db:create
+    DevUp! INFO starting up...
+    DevUp! INFO up
 
-    $ bundle exec rails server
+    $ Created database 'dummy_rails_test'
 
 
 ## Without Rails
@@ -71,12 +71,15 @@ DB = Sequel.connect(ENV.fetch("DATABASE_URL"))
 
 ## Without Ruby (PHP, nodejs, Java, ...)
 
+Install DevUp!
+
+    $ gem install devup
+
 Start up services
 
-    $ devup
-    dummy_rails_postgres_1 is up-to-date
-    dummy_rails_redis_1 is up-to-date
-    dummy_rails_memcached_1 is up-to-date
+    $ devup up
+    DevUp! INFO starting up...
+    DevUp! INFO up
 
     $ cat .env.services
     export POSTGRES_HOST=0.0.0.0
@@ -100,6 +103,10 @@ Now you can run app
 
 If you don't want devup to setup your dev services, you can disable it by using `DEVUP_ENABLED=false`. Just add it to .env.local file.
 
+### Debug
+
+    $ export DEVUP_LOG_LEVEL=debug
+    $ devup up
 
 ## Development
 

data/devup.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dotenv"
+  spec.add_dependency "dry-cli"
 end

data/docker-compose.devup.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  postgres:
+    image: postgres:11
+    ports:
+      - "5432"
+
+  web:
+    image: nginx
+

data/exe/devup

@@ -1,13 +1,5 @@
 #!/usr/bin/env ruby
 
-require "devup/environment"
+require "devup/cli"
 
-devup = Devup::Environment.new pwd: `pwd`
-
-# TODO: use dry-cli here
-case ARGV[0]
-when "down"
-  devup.down
-else
-  devup.up
-end
+Dry::CLI.new(Devup::CLI::Commands).call

data/lefthook.yml

@@ -0,0 +1,7 @@
+pre-commit:
+  parallel: true
+  commands:
+    lint:
+      files: git diff --name-only --staged
+      glob: "*.rb"
+      run: standardrb --force-exclusion {files}

data/lib/devup/boot.rb

@@ -1,5 +1,8 @@
 if ENV.fetch("DEVUP_ENABLED", "true") == "true"
-  devup = Devup::Environment.new pwd: `pwd`
+  devup = Devup::Environment.new(
+    pwd: `pwd`,
+    logger: Devup::Logger.build(ENV.fetch("DEVUP_LOG_LEVEL", "info"))
+  )
   devup.up
 
   begin

data/lib/devup/cli.rb

@@ -0,0 +1,22 @@
+require "dry/cli"
+
+require "devup/cli/commands/up"
+require "devup/cli/commands/down"
+
+module Devup
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        def call(*)
+          puts Devup::VERSION
+        end
+      end
+    end
+  end
+end
+
+Devup::CLI::Commands.register "version", Devup::CLI::Commands::Version, aliases: ["v", "-v", "--version"]
+Devup::CLI::Commands.register "up", Devup::CLI::Commands::Up
+Devup::CLI::Commands.register "down", Devup::CLI::Commands::Down

data/lib/devup/cli/commands/command.rb

@@ -0,0 +1,38 @@
+require "devup/logger"
+
+module Devup
+  module CLI
+    module Commands
+      class Command < Dry::CLI::Command
+        def call(**options)
+          @opts = options
+        end
+
+        private
+
+        attr_reader :opts
+
+        def logger
+          @logger ||= Devup::Logger.build(log_level)
+        end
+
+        def log_level
+          if opts.fetch(:verbose)
+            :debug
+          else
+            :info
+          end
+        end
+
+        def devup
+          require "devup/environment"
+
+          @devup ||= Devup::Environment.new(
+            pwd: `pwd`,
+            logger: logger
+          )
+        end
+      end
+    end
+  end
+end

data/lib/devup/cli/commands/down.rb

@@ -0,0 +1,17 @@
+module Devup
+  module CLI
+    module Commands
+      class Down < Command
+        desc "Stop dev services"
+
+        option :verbose, type: :boolean, default: false, desc: "Verbose"
+
+        def call(**options)
+          super
+
+          devup.down
+        end
+      end
+    end
+  end
+end

data/lib/devup/cli/commands/up.rb

@@ -0,0 +1,33 @@
+require "devup/cli/commands/command"
+module Devup
+  module CLI
+    module Commands
+      class Up < Command
+        desc "Run dev services"
+
+        option :verbose, type: :boolean, default: false, desc: "Verbose"
+
+        def call(**options)
+          super
+
+          devup.up
+          print_info
+        end
+
+        private
+
+        def print_info
+          puts <<~INFO
+
+            Now you are ready to use services. All variables are available
+            in a .env.services file. Just start you ruby application if
+            gem "devup" is used. Or load variable manually with
+
+                $ source .env.services
+
+          INFO
+        end
+      end
+    end
+  end
+end

data/lib/devup/compose.rb

@@ -1,22 +1,22 @@
 require "yaml"
-require "open3"
+
+require "devup/compose/ps"
 
 module Devup
   class Compose
-    attr_reader :path, :project, :logger
+    attr_reader :path, :project, :logger, :shell
 
     class Error < StandardError; end
 
-    def initialize(path, project: "devup", logger:)
+    def initialize(path, project: "devup", logger:, shell:)
       @path = path
       @project = project
       @logger = logger
+      @shell = shell
     end
 
     def check
-      _output, status = safe_exec("docker-compose -v")
-
-      status
+      true
     end
 
     def services
@@ -24,11 +24,19 @@ module Devup
     end
 
     def service_ports(name)
-      config["services"][name]["ports"]
+      return [] if config["services"][name]["ports"].nil?
+
+      config["services"][name]["ports"].map { |el| el.to_s.split(":")[-1].to_i }
+    end
+
+    def port_mapping(service, port)
+      exec("port #{service} #{port}").split(":")[-1].strip.to_i
     end
 
     def up
-      exec "up -d --remove-orphans --renew-anon-volumes"
+      exec "up -d --remove-orphans"
+
+      wait_alive 3
     end
 
     def stop
@@ -39,22 +47,32 @@ module Devup
       exec "rm -f"
     end
 
-    def exec(cmd)
-      output, status = safe_exec "docker-compose -p #{project} -f #{path} #{cmd}"
+    private
+
+    def wait_alive(timeout, retry_sleep: 0.3)
+      start = Time.now
 
-      raise(Error) unless status
+      loop {
+        break if alive?
 
-      output
+        if Time.now - start > timeout
+          logger.error "can't run services"
+          break
+        end
+        sleep retry_sleep
+      }
     end
 
-    private
+    def alive?
+      ComposeHelpers::Ps.new(exec("ps")).up?
+    end
 
-    def safe_exec(cmd)
-      output, error, status = Open3.capture3(cmd + ";")
+    def exec(cmd)
+      resp = shell.exec "docker-compose -p #{project} -f #{path} #{cmd}"
 
-      logger.error(error) unless status.success?
+      raise(Error) unless resp.success?
 
-      [output, status.success?]
+      resp.data
     end
 
     def config

data/lib/devup/compose/ps.rb

@@ -0,0 +1,30 @@
+module Devup
+  module ComposeHelpers
+    class Ps
+      attr_reader :output
+      def initialize(output)
+        @output = output
+      end
+
+      def up?
+        service_lines.map { |line|
+          line.match(/Up/) && !line.match(/Exit/)
+        }.all?
+      end
+
+      def port_mapping(port)
+        m = output.match(/\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}:(\d+)->#{port}\/tcp/)
+
+        return if m.nil?
+
+        m[1].to_i
+      end
+
+      private
+
+      def service_lines
+        output.split("\n")[2..-1]
+      end
+    end
+  end
+end

data/lib/devup/environment.rb

@@ -4,15 +4,17 @@ require "devup/logger"
 require "devup/compose"
 require "devup/service"
 require "devup/service_presenter"
+require "devup/shell"
 
 module Devup
   class Environment
-    attr_reader :pwd, :compose, :logger
+    attr_reader :pwd, :logger, :shell
 
-    def initialize(pwd:, compose: nil, logger: Logger.default)
+    def initialize(pwd:, compose: nil, logger: Logger.build, shell: Shell.new(pwd: pwd, logger: logger))
       @pwd = pwd.to_s.strip
-      @compose = compose || Compose.new(root.join("docker-compose.devup.yml"), project: project, logger: logger)
+      @compose = compose
       @logger = logger
+      @shell = shell
     end
 
     def project
@@ -24,26 +26,27 @@ module Devup
     end
 
     def up
-      logger.info "DevUp! is starting up services..."
+      logger.info "starting up..."
       check
       compose.up
       write_dotenv
-      logger.info "DevUp! is up"
+      logger.info "up"
+    rescue => ex
       clear_dotenv
-
-    rescue StandardError
-      logger.info "DevUp! halted"
+      logger.debug ex
+      logger.error "halted"
+      raise ex
     end
 
     def down
-      logger.info "DevUp! is shutting down services..."
+      logger.info "shutting down..."
       compose.stop
       compose.rm
       clear_dotenv
-      logger.info "DevUp! is down"
-
-    rescue StandardError
-      logger.info "DevUp! halted"
+      logger.info "down"
+    rescue => ex
+      logger.debug ex
+      logger.info "halted"
     end
 
     def root
@@ -53,11 +56,8 @@ module Devup
     private
 
     def check
-      return false if missing_config
-
+      raise if missing_config
       compose.check
-
-      true
     end
 
     def missing_config
@@ -100,5 +100,14 @@ module Devup
 
       DOTENV
     end
+
+    def compose
+      @compose ||= begin
+                     Compose.new(
+                       root.join("docker-compose.devup.yml"),
+                       project: project, logger: logger, shell: shell
+                     )
+                   end
+    end
   end
 end

data/lib/devup/logger.rb

@@ -2,9 +2,13 @@ require "logger"
 
 module Devup
   class Logger < ::Logger
-    def self.default
-      formatter = ->(_severity, _time, _progname, msg) { "#{msg}\n" }
-      new(STDOUT, formatter: formatter)
+    def self.build(level = :info)
+      formatter = ->(severity, _time, _progname, msg) { "DevUp! #{severity} #{msg}\n" }
+      logger = new(STDOUT, formatter: formatter)
+
+      logger.level = level
+
+      logger
     end
   end
 end

data/lib/devup/port_checker.rb

@@ -0,0 +1,16 @@
+require "socket"
+require "timeout"
+
+module Devup
+  class PortChecker
+    def call(port)
+      s = TCPSocket.new("0.0.0.0", port)
+      s.write "1"
+      s.close
+
+      true
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+      false
+    end
+  end
+end

data/lib/devup/service.rb

@@ -16,10 +16,10 @@ module Devup
     private
 
     def fetch_ports
-      compose.service_ports(name).map { |el| el.to_s.split(":")[-1] }.map do |from|
+      compose.service_ports(name).map do |from|
         OpenStruct.new(
-          from: from.to_i,
-          to: compose.exec("port #{name} #{from}").split(":")[-1].strip.to_i
+          from: from,
+          to: compose.port_mapping(name, from)
         )
       end
     end

data/lib/devup/service_presenter.rb

@@ -11,7 +11,6 @@ module Devup
       res = []
 
       res << "# #{service.name}"
-      res << magic if magic?
 
       if has_ports?
         res << host_env
@@ -53,36 +52,12 @@ module Devup
       service.ports.size > 0
     end
 
-    def magic?
-      %w[postgres redis mysql memcached].include? service.name
-    end
-
-    def magic
-      case service.name
-      when "postgres"
-        "export DATABASE_URL=postgres://postgres@0.0.0.0:#{port_to(5432)}/#{database_name}"
-      when "mysql"
-        "export DATABASE_URL=mysql2://root@0.0.0.0:#{port_to(3306)}/#{database_name}"
-      when "redis"
-        "export REDIS_URL=redis://0.0.0.0:#{port_to(6379)}"
-      when "memcached"
-        "export MEMCACHE_SERVERS=0.0.0.0:#{port_to(11211)}"
-      end
-    end
-
     def port_to(from)
       service.ports.find { |p| p.from == from }&.to
     end
 
     def database_name
-      if defined? Rails
-        [
-          project,
-          Rails.env
-        ].join("_")
-      else
-        "db"
-      end
+      "db"
     end
   end
 end

data/lib/devup/shell.rb

@@ -0,0 +1,28 @@
+require "open3"
+
+module Devup
+  class Shell
+    attr_reader :pwd, :logger
+
+    def initialize(pwd:, logger:)
+      @pwd = pwd
+      @logger = logger
+    end
+
+    Result = Struct.new(:data, :status) {
+      def success?
+        status
+      end
+    }
+
+    def exec(cmd)
+      logger.debug "$ #{cmd}"
+
+      output, error, status = Open3.capture3(cmd + ";")
+
+      logger.error(error) unless status.success?
+
+      Result.new(output, status.success?)
+    end
+  end
+end

data/lib/devup/version.rb

@@ -1,3 +1,3 @@
 module Devup
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - sergei@udalovs.ru
@@ -47,15 +61,24 @@ files:
 - bin/console
 - bin/setup
 - devup.gemspec
+- docker-compose.devup.yml
 - exe/devup
+- lefthook.yml
 - lib/devup.rb
 - lib/devup/boot.rb
+- lib/devup/cli.rb
+- lib/devup/cli/commands/command.rb
+- lib/devup/cli/commands/down.rb
+- lib/devup/cli/commands/up.rb
 - lib/devup/compose.rb
+- lib/devup/compose/ps.rb
 - lib/devup/dotenv.rb
 - lib/devup/environment.rb
 - lib/devup/logger.rb
+- lib/devup/port_checker.rb
 - lib/devup/service.rb
 - lib/devup/service_presenter.rb
+- lib/devup/shell.rb
 - lib/devup/version.rb
 homepage: https://github.com/sergio-fry/devup
 licenses: