devup 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b7a8648ef05f7206cc02900450f8f303fc948a0976ac959472451eeef1988f
-  data.tar.gz: a58834288dcd48d1cde4e353f1a77fb40b15419751896bdd7680b71be64a7266
+  metadata.gz: d83b3c98d30a71d2414a1fc5106d9a907612911f4b05a2246404f08215be203c
+  data.tar.gz: 772cee331bdcd822f497cc7121a6d6201b971b65b930e47864770d7cbb30df62
 SHA512:
-  metadata.gz: 340f23ba29e0cd7e9c187f3ddb20d5e7c825503c5095fd4e3acd244ae2f714f89c2cfe636533207391292685244f4459b70af87a09ad82e7e8b3d9e70639aead
-  data.tar.gz: d596434a6a8450bf01b433a2f2e4c3abbed3f465046463954595badb82468fabd0f3fc6479d0fe9935dc1bbd48b246e11aabd723251b81b2d288ff7d103b822c
+  metadata.gz: e29107cb8acd259d0e1f038e93cd7809e5b933abdedace59e17001e974220632ed95fe14aadb8e28007c6164665fbd4b4398268b1b476d35042c89457dde78b7
+  data.tar.gz: 7145ada30c07f14547ea5fc4c3d6ef9222a7dee288bb2d38b547a1907d844646e737d43a8f740668739465de60217d7e1a0501601618bb5e270c77e99903e713

data/.gitignore

@@ -14,6 +14,8 @@
 # Editor config
 .vimrc
 
+.env.services
 spec/dummy/.env.services
+spec/dummy_rails/.env.services
 
 devup-*.gem

data/.standard.yml

@@ -0,0 +1,2 @@
+ignore:
+  - 'spec/dummy_rails/**/*'

data/.travis.yml

@@ -5,6 +5,8 @@ language: ruby
 cache: bundler
 rvm:
 - 2.7.1
+- 2.6.6
+- 2.5.8
 services:
 - docker
 before_install:

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devup (0.2.0)
+    devup (0.3.3)
       dotenv
 
 GEM
@@ -14,6 +14,7 @@ GEM
     dotenv (2.7.5)
     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 +61,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   devup!
+  lefthook
   rake (~> 12.0)
   rspec (~> 3.0)
   simplecov

data/README.md

@@ -1,96 +1,112 @@
-# 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)
 
-[![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)
+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.
 
-**DevUp!** is a tool to run dev dependencies. It builds ENV vars with dynamic exposed ports for services defined in a docker-compose.yml to access from application.
 
-![demo](demo.gif)
+## Requirements
 
-## Installation
+* Docker (>= 19.03.8)
+* Docker Compose (>= 1.25.5)
 
-    $ gem install devup
 
-## Usage
 
+## Rails
 
-Create a docker-compose.yml with app dependencies like:
+Create a docker-compose.devup.yml with app dependencies like:
 
 ```yaml
-version: '3'
+version: "3"
 
 services:
   postgres:
-    image: postgres
+    image: postgres:10-alpine
     ports:
       - "5432"
 ```
 
-Add devup/dotenv to your Gemfile:
-
-    gem "devup"
+Add **DevUp!** to your Gemfile
 
-For each service from docker-compose.yml **DevUp!**  will export ENV variable like
+```ruby
+gem "devup", group: [:development, :test]
+```
 
-    POSTGRES_HOST=0.0.0.0
-    POSTGRES_PORT=5432
+and
 
-### Rails
+    $ bundle install
 
 
 Update your database.yml to use ENV:
 
 ```yaml
-default: &default
-  adapter: postgresql
-  encoding: unicode
-  host: <%= ENV.fetch("POSTGRES_HOST") %>
-  port: <%= ENV.fetch("POSTGRES_PORT") %>
-  username: postgres
-  password:
+test:
+  url: <%= ENV.fetch("DATABASE_URL") %>
 
 development:
-  <<: *default
-  database: development
+  url: <%= ENV.fetch("DATABASE_URL") %>
 
-test:
-  <<: *default
-  database: test
 ```
 
 
-You are ready to start rails
+You are ready to use rails with PostgreSQL configured
+
+    $ RAILS_ENV=test bundle exec rake db:create
+    DevUp! INFO starting up...
+    DevUp! INFO up
 
-    $ bundle exec rake db:create db:migrate
-    $ bundle exec rails server
+    $ Created database 'dummy_rails_test'
 
 
-### Without Rails
+## Without Rails
+
+ENV vars from .env.services are loaded with dotenv automatically.
 
 
 ```ruby
 require "devup"
 require "sequel"
 
-DB = Sequel.connect("postgres://postgres@#{ENV.fetch( "POSTGRES_HOST" )}:#{ENV.fetch("POSTGRES_PORT")}/database_name")
+DB = Sequel.connect(ENV.fetch("DATABASE_URL"))
 ```
 
 
-### Without Ruby (PHP, nodejs, Java, ...)
+## Without Ruby (PHP, nodejs, Java, ...)
+
+Install DevUp!
+
+    $ gem install devup
 
 Start up services
 
     $ devup
+    DevUp! INFO starting up...
+    DevUp! INFO up
+
+    $ cat .env.services
+    export POSTGRES_HOST=0.0.0.0
+    export POSTGRES_PORT=32944
+    export POSTGRES_PORT_5432=32944
+    export MEMCACHED_HOST=0.0.0.0
+    export MEMCACHED_PORT=32943
+    ...
 
-Load ENV vars from generated .env.services
+Use your favourite dotenv extension to load vars from .env.services ([node-dotenv](https://www.npmjs.com/package/dotenv), [python-dotenv](https://pypi.org/project/python-dotenv/), [phpdotenv](https://github.com/vlucas/phpdotenv), ...)
+
+Or load ENV vars manually
 
     $ source .env.services
 
 Now you can run app
 
+## How To
+
+### Disable **DevUp!**
+
+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
 
 ## Development
 

data/docker-compose.devup.yml

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

data/exe/devup

@@ -2,7 +2,10 @@
 
 require "devup/environment"
 
-devup = Devup::Environment.new pwd: `pwd`
+devup = Devup::Environment.new(
+  pwd: `pwd`,
+  logger: Devup::Logger.build(ENV.fetch("DEVUP_LOG_LEVEL", "info"))
+)
 
 # TODO: use dry-cli here
 case ARGV[0]

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,2 +1,15 @@
-devup = Devup::Environment.new pwd: `pwd`
-devup.up
+if ENV.fetch("DEVUP_ENABLED", "true") == "true"
+  devup = Devup::Environment.new(
+    pwd: `pwd`,
+    logger: Devup::Logger.build(ENV.fetch("DEVUP_LOG_LEVEL", "info"))
+  )
+  devup.up
+
+  begin
+    require "spring/commands"
+
+    Spring.watch devup.root.join("docker-compose.yml")
+  rescue LoadError, ArgumentError
+    # Spring is not available
+  end
+end

data/lib/devup/compose.rb

@@ -1,12 +1,22 @@
 require "yaml"
 
+require "devup/compose/ps"
+
 module Devup
   class Compose
-    attr_reader :path, :project
+    attr_reader :path, :project, :logger, :shell
+
+    class Error < StandardError; end
 
-    def initialize(path, project: "devup")
+    def initialize(path, project: "devup", logger:, shell:)
       @path = path
       @project = project
+      @logger = logger
+      @shell = shell
+    end
+
+    def check
+      true
     end
 
     def services
@@ -14,11 +24,17 @@ module Devup
     end
 
     def service_ports(name)
-      config["services"][name]["ports"]
+      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"
+
+      wait_alive 3
     end
 
     def stop
@@ -29,11 +45,33 @@ module Devup
       exec "rm -f"
     end
 
-    def exec(cmd)
-      `docker-compose -p #{project} -f #{path} #{cmd}`
+    private
+
+    def wait_alive(timeout, retry_sleep: 0.3)
+      start = Time.now
+
+      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(cmd)
+      resp = shell.exec "docker-compose -p #{project} -f #{path} #{cmd}"
+
+      raise(Error) unless resp.success?
+
+      resp.data
+    end
 
     def config
       YAML.safe_load(config_content)

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

@@ -1,52 +1,51 @@
 require "yaml"
 
+require "devup/logger"
 require "devup/compose"
 require "devup/service"
+require "devup/service_presenter"
+require "devup/shell"
 
 module Devup
   class Environment
-    attr_reader :pwd, :compose
+    attr_reader :pwd, :logger, :shell
 
-    def initialize(pwd:, compose: nil)
+    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.yml"), project: project)
+      @compose = compose
+      @logger = logger
+      @shell = shell
     end
 
     def project
       pwd.split("/")[-1].strip
     end
 
-    def vars
-      compose.services.map { |name| Service.new(compose, name) }.map { |service|
-        res = []
-
-        res << {"#{service.name}_HOST".upcase => "0.0.0.0"}
-
-        if service.ports.size > 0
-          res << {"#{service.name}_PORT".upcase => service.ports.first.to}
-
-          service.ports.each do |port|
-            res << {"#{service.name}_PORT_#{port.from}".upcase => port.to}
-          end
-        end
-
-        res
-      }.flatten
-    end
-
     def env
-      vars.reduce({}, :merge).map { |k, v| "export #{k}=#{v}" }.join("\n")
+      services.map { |s| service_env(s) }.join("\n\n")
     end
 
     def up
+      logger.info "starting up..."
+      check
       compose.up
       write_dotenv
+      logger.info "up"
+    rescue => ex
+      clear_dotenv
+      logger.debug ex
+      logger.error "halted"
     end
 
     def down
+      logger.info "shutting down..."
       compose.stop
       compose.rm
       clear_dotenv
+      logger.info "down"
+    rescue => ex
+      logger.debug ex
+      logger.info "halted"
     end
 
     def root
@@ -55,6 +54,29 @@ module Devup
 
     private
 
+    def check
+      raise if missing_config
+      compose.check
+    end
+
+    def missing_config
+      if File.exist?(compose.path)
+        false
+      else
+        logger.error "missing #{compose.path}"
+
+        true
+      end
+    end
+
+    def services
+      @services ||= compose.services.map { |name| Service.new(compose, name) }
+    end
+
+    def service_env(service)
+      ServicePresenter.new(service, project: project).call
+    end
+
     def write_dotenv
       File.open(root.join(".env.services"), "w") { |f| f.write dotenv }
     end
@@ -70,10 +92,21 @@ module Devup
         #     Home: https://github.com/sergio-fry/devup    #
         ####################################################
         # START
+
         #{env}
+
         # END
 
       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

@@ -0,0 +1,14 @@
+require "logger"
+
+module Devup
+  class Logger < ::Logger
+    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

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

data/lib/devup/service_presenter.rb

@@ -0,0 +1,63 @@
+module Devup
+  class ServicePresenter
+    attr_reader :service, :project
+
+    def initialize(service, project: nil)
+      @service = service
+      @project = project
+    end
+
+    def call
+      res = []
+
+      res << "# #{service.name}"
+
+      if has_ports?
+        res << host_env
+        res << ports_env
+      else
+        res << "# no exposed ports"
+      end
+
+      res.join "\n"
+    end
+
+    private
+
+    def host_env
+      "export #{service.name.upcase}_HOST=0.0.0.0"
+    end
+
+    def ports_env
+      res = []
+
+      res << port_env(to: service.ports.first.to) if service.ports.size == 1
+
+      service.ports.each do |port|
+        res << port_env(from: port.from, to: port.to)
+      end
+
+      res.join "\n"
+    end
+
+    def port_env(from: nil, to:)
+      if from.nil?
+        "export #{service.name.upcase}_PORT=#{to}"
+      else
+        "export #{service.name.upcase}_PORT_#{from}=#{to}"
+      end
+    end
+
+    def has_ports?
+      service.ports.size > 0
+    end
+
+    def port_to(from)
+      service.ports.find { |p| p.from == from }&.to
+    end
+
+    def database_name
+      "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.2.0"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".standard.yml"
 - ".travis.yml"
 - ".vimrc"
 - CODE_OF_CONDUCT.md
@@ -45,15 +46,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- demo.gif
 - devup.gemspec
+- docker-compose.devup.yml
 - exe/devup
+- lefthook.yml
 - lib/devup.rb
 - lib/devup/boot.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: