dockerbash 0.1.0

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 crawler8086@gmail.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dockerbash.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jordi Garcia
+
+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,64 @@
+# Dockerbash
+
+A very basic command line rubygem that makes easier to execute a bash into running Docker containers.
+
+Sometimes when you are running docker containers, you need to inspect the status of services, files, configurations, this gem provides the ability to log into running containers using a GNU Bourne-Shell and debug the container from another shell.
+
+## Requirements
+
+This command line tool has been developed and tested on Gnu/Linux environments, it won't run on Darwin (OS X) systems.
+
+In order to run dockerbash, you must install the package that contains the header files for compiling extension modules for Ruby.
+
+Based on DEB
+```
+$ sudo apt-get install build-essential ruby-dev
+```
+Based on RPM
+```
+$ sudo yum install -y gcc gcc-c++ ruby-devel libxml2 libxml2-devel libxslt libxslt-devel
+```
+
+## Installation
+Install the gem yourself:
+```
+$ gem install dockerbash
+```
+
+## Usage
+How to run it:
+```  
+$ dockerbash
+```  
+
+Example menu:
+
+```
+       _            _             _               _       
+    __| | ___   ___| | _____ _ __| |__   __ _ ___| |___   
+   / _` |/ _ \ / __| |/ / _ \  __|  _ \ / _` / __|  _  |  
+  | (_| | (_) | (__|   <  __/ |  | |_) | (_| \__ \ | | |  
+   \____|\___/ \___|_|\_\___|_|  |____/ \____|___/_| |_|  
+                                                          
+                                     v.0.1.0  - by m8051  
+
+0. Container:docker_nginx_1 	 Ip:172.17.0.3 	 Ports: 80/tcp -> 8080  
+1. Container:docker_php7-fpm_1 	 Ip:172.17.0.2 	 Ports: 9000/tcp -> 9001  
+Container?  0
+root@2d7083aa1744:/#
+```                                          
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dockerbash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dockerbash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/dockerbash

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'dockerbash'
+rescue LoadError
+  require 'rubygems'
+  require 'dockerbash'
+end
+
+# Clean exit with CTRL+C
+trap("INT") { exit }
+
+dockerbash = Dockerbash::Client.new()
+dockerbash.select_docker_container()

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dockerbash.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dockerbash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dockerbash"
+  spec.version       = Dockerbash::VERSION
+  spec.authors       = ["Jordi"]
+  spec.email         = ["crawler8086@gmail.com"]
+
+  spec.summary       = %q{A script to make it easier to execute a bash into running Docker containers}
+  spec.description   = %q{Sometimes when you are running docker containers, you need to inspect the status of services, files, configurations, this gem provides the ability to log into running containers using a GNU Bourne-Shell and debug the container from another shell}
+  spec.homepage      = "https://github.com/m8051/dockerbash"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["dockerbash"]
+  spec.require_paths = ["lib"]
+  spec.rubygems_version = "1.8.23"
+
+  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_runtime_dependency 'colorize', '~> 0.7'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+end

data/lib/dockerbash.rb

@@ -0,0 +1,90 @@
+require "dockerbash/version"
+require "highline/import"
+require "fileutils"
+require "colorize"
+require "open3"
+require "mkmf"
+
+# Preventing mkmf to:
+#  => litter with log files.
+#  => non-verbose stdout
+module Logging
+   @logfile = File::NULL
+   @quiet = true
+end
+
+module Dockerbash
+
+  class Client
+
+    def initialize()
+      banner
+      @docker_path = find_docker()
+    end
+
+    def select_docker_container()
+      counter = 0
+      docker_ids = []
+      ids = get_docker_containers_ids()
+      ids.each do |i|
+        cn_stdout, cn_stderr, cn_status = Open3.capture3("#{@docker_path} inspect --format={{.Name}} #{i}")
+        container_name = cn_stdout.gsub(/\n/,'')
+        container_name.delete!("/")
+
+        ci_stdout, ci_stderr, ci_status = Open3.capture3("#{@docker_path} inspect --format={{.NetworkSettings.IPAddress}} #{i}")
+        container_ip = ci_stdout.gsub(/\n/,'')
+        container_ip.delete("/")
+
+        cb_stdout, cb_stderr, cb_status = Open3.capture3("#{@docker_path} inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' #{i}")
+        container_bindings = cb_stdout.gsub(/\n/,'')
+
+        container_ids = i
+        puts "#{counter}. Container:#{container_name}\tIp:#{container_ip}\tPorts:#{container_bindings}"
+        docker_ids << container_ids
+        counter += 1
+      end
+
+      selected_id = ask("Container? ", Integer) { |q| q.in = 0..docker_ids.count }
+      command = "#{@docker_path} exec -t -i #{docker_ids[selected_id]} /bin/bash"
+      exec(command)
+    end
+    
+    private
+    
+    def banner
+     puts '       _            _             _               _       '.green.bold
+     puts '    __| | ___   ___| | _____ _ __| |__   __ _ ___| |___   '.green.bold
+     puts '   / _` |/ _ \ / __| |/ / _ \  __|  _ \ / _` / __|  _  |  '.white.bold
+     puts '  | (_| | (_) | (__|   <  __/ |  | |_) | (_| \__ \ | | |  '.white.bold
+     puts '   \____|\___/ \___|_|\_\___|_|  |____/ \____|___/_| |_|  '.yellow.bold
+     puts '                                                          '.yellow.bold
+     puts '                                     v.0.1.0  - by m8051  '.red.bold
+     puts ''
+   end
+
+   def find_docker()
+     docker_path = find_executable('docker', path = nil)
+     if docker_path.nil? || docker_path.empty?
+       msg = " -- Docker not found, is the docker package installed?".red
+       abort(msg)
+     else
+       return docker_path
+     end
+   end
+
+   def get_docker_containers_ids()
+     docker_containers_ids = []
+     stdout, stdeerr, status = Open3.capture3("#{@docker_path} ps -aq -f status=running")
+     if stdout.nil? || stdout.empty?
+       msg = "  -- Is the Docker daemon running and the containers up?".red
+       abort(msg)
+     else
+       concat_stdout = stdout.gsub(/\n/,' ')
+       docker_containers_ids = concat_stdout.split(" ")
+       return docker_containers_ids
+     end
+   end
+  
+  end
+
+end

data/lib/dockerbash/version.rb

@@ -0,0 +1,3 @@
+module Dockerbash
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: dockerbash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jordi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Sometimes when you are running docker containers, you need to inspect
+  the status of services, files, configurations, this gem provides the ability to
+  log into running containers using a GNU Bourne-Shell and debug the container from
+  another shell
+email:
+- crawler8086@gmail.com
+executables:
+- dockerbash
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/dockerbash
+- bin/setup
+- dockerbash.gemspec
+- lib/dockerbash.rb
+- lib/dockerbash/version.rb
+homepage: https://github.com/m8051/dockerbash
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A script to make it easier to execute a bash into running Docker containers
+test_files: []