devup 0.3.2 → 0.4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d56bfb5d2d4fd21f7326151031d7bb37c4228f6956c48a796f18c7fc623798e8
-  data.tar.gz: bde24f19bd8a2e2b8abbf449d20169b5ee2bca39d68a8c4f438d396793585288
+  metadata.gz: 96dfaf1740d9680c2a7060ac68cec0e442df06c459a802f96509429b19ff7ac7
+  data.tar.gz: 01423f04ef9c067798d12d595421ba51ef75410ebfe42c55c66f16dbf265aef2
 SHA512:
-  metadata.gz: 6d31aa4918137722bcfe843398d1c72fa5c07445b2a2e0b283b386b01f4d5e21a8ed7e4a4bd8b9ceb0c36a0558ffd6daabf39862dff51394b8c7706cfc3015e2
-  data.tar.gz: fa38296b3c063c39d7850e7962007324884548b34e82994467ab0f1c1cc4f6d8ce63129ac39d4b9379d8c71ef85524949900f46b37af95ab9ddd3e5667de6551
+  metadata.gz: d33c8f40d01c63d1c1d3738e095b7975d78cd7e08a5abecfdc6f5d2349f06216d993e382bf94ccafe117c4e750b5e5973723228ec028d4a86aa2b3212dd2bfad
+  data.tar.gz: c43fb7fd47119bbfe821f26e06d6b081fcfcb93f31310a9e89bf0d7e61544822d5d5051db26b3574f3b42e02504464ef39733fedbc6f5f3eb8eb82cf73f1e990

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.2)
+    devup (0.4.3.1)
       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(port)
+      ComposeHelpers::Ps.new(exec_ps_cached).port_mapping(port)
     end
 
     def up
       exec "up -d --remove-orphans"
+
+      wait_alive 3
     end
 
     def stop
@@ -39,22 +47,40 @@ module Devup
       exec "rm -f"
     end
 
-    def exec(cmd)
-      output, status = safe_exec "docker-compose -p #{project} -f #{path} #{cmd}"
+    private
 
-      raise(Error) unless status
+    def wait_alive(timeout, retry_sleep: 0.3)
+      start = Time.now
 
-      output
+      loop {
+        break if alive?
+
+        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 exec_ps
+      @exec_ps_output = exec("ps")
+    end
+
+    def exec_ps_cached
+      @exec_ps_output ||= exec("ps")
+    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,24 +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"
-    rescue
+      logger.info "up"
+    rescue => ex
       clear_dotenv
-      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
-      logger.info "DevUp! halted"
+      logger.info "down"
+    rescue => ex
+      logger.debug ex
+      logger.info "halted"
     end
 
     def root
@@ -51,11 +56,8 @@ module Devup
     private
 
     def check
-      return false if missing_config
-
+      raise if missing_config
       compose.check
-
-      true
     end
 
     def missing_config
@@ -98,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(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
@@ -32,7 +31,7 @@ module Devup
     def ports_env
       res = []
 
-      res << port_env(to: service.ports.first.to) if service.ports.size == 1
+      res << port_env(to: service.ports.first.to)
 
       service.ports.each do |port|
         res << port_env(from: port.from, to: port.to)
@@ -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.2"
+  VERSION = "0.4.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.3.1
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-07-03 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: