vagrant-redir 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520d98ec8a1edb028e8848406a63f75431090f69
-  data.tar.gz: 646b6dc05fd5fd6fe01129cb121c001c8163fd9d
+  metadata.gz: b1c8789c7750060b8749d313883dce21fcad8bf9
+  data.tar.gz: ef453e3fafa1f95d1147de45274d9e602ab45ff4
 SHA512:
-  metadata.gz: 39e2236cbf28c00adfeabb6979691cf093defd5157406d6e2d8400d0d9931645276089aa7306dab2bd9865556f43a389f3683018c3e7e3f9f4bc2b1b0d228852
-  data.tar.gz: c89c495e96b808bb65b07a9ed7dbf62292b9b78e302f1f7489161b15a524d31c05bb5b56bfc606efe01947846b5471ecd9efe2dc190207ca9244d26525fb5005
+  metadata.gz: 3abde7d52ca301d85887b26f740a8ba4c87c8c7a4815313b24c255ca6357a2ef9bb1eee892d2bee332622e6fc735be07e17662f35a87f4b0e72f30c206fa375c
+  data.tar.gz: 0ad8718b6c11d81ab83a17475bdaf3fb8bc9b508bf5c4edfd0d3e760e97b4d55199f9cfcfae60a6ad2ee425724cc864e3064cea599b244724f7f09eccca7a740

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.vagrant
+Vagrantfile
+vagrant-scripts
+puppet
+*.gem
+.*.swp
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0.pre.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "bundler", "~> 1.13"
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 3.0"
+  gem "vagrant-redir", path: "."
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 st02tkh
+
+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,236 @@
+# vagrant-redir
+
+This plugin allows to manage redir's ports forwarding used by vagrant-lxc provider.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```shell
+$ vagrant plugin install vagrant-redir
+```
+or 
+
+```shell
+$ git clone https://github.com/st02tkh/vagrant-redir.git
+$ cd vagrant-redir
+$ gem build vagrant-redir.gemspec
+$ vagrant plugin install ./vagrant-redir-X.Y.Z.gem
+```
+
+## Usage
+
+Show available subcommands: 
+
+```shell
+$ vagrant redir <subcommand>
+```
+
+Shows a help for a subcommand run it with '-h':
+
+```shell
+$ vagrant redir <subcommand> -h
+```
+
+
+### addr
+
+Shows a list of VM's ID, name and public IP
+
+```shell
+$ vagrant redir addr
+```
+
+will show:
+
+```shell
+List of VM(s) public IP addresses:
+ id: xdg_1506653541513_93050 name: xdg ip: 10.0.3.173
+ id: db1_1506915461158_4146 name: db1 ip: 10.0.3.55
+```
+
+or for particular VM:
+
+```shell
+$ vagrant redir addr [<name>]
+```
+
+
+
+### config
+
+Shows a list of VMs with a list of forwarded port for it:
+
+```shell
+$ vagrant redir config
+```
+
+will show:
+
+```shell
+Port forwarding configuration for VM 'xdg':
+ guest: 8000, host: 8900, host_ip: 0.0.0.0, protocol: tcp
+ guest: 8001, host: 8901, host_ip: 0.0.0.0, protocol: tcp
+ guest: 80, host: 8908, host_ip: 0.0.0.0, protocol: tcp
+ guest: 22, host: 8902, host_ip: 0.0.0.0, protocol: tcp
+
+Port forwarding configuration for VM 'db1':
+ guest: 8000, host: 9000, host_ip: 0.0.0.0, protocol: tcp
+ guest: 8001, host: 9001, host_ip: 0.0.0.0, protocol: tcp
+ guest: 80, host: 9080, host_ip: 0.0.0.0, protocol: tcp
+ guest: 22, host: 9022, host_ip: 0.0.0.0, protocol: tcp
+```
+or for particular VM:
+
+```shell
+$ vagrant redir config [<name>]
+```
+
+
+
+### down 
+
+Shut down redir processes used for port forwarding for VMs.
+Same process vagrant starts on 'vagrant halt' command.
+
+```shell
+$ vagrant redir down
+```
+or for particular VM:
+
+```shell
+$ vagrant redir down [<name>]
+```
+
+
+
+### kill 
+
+Kill redir processes used for port forwarding for VMs.
+This is usefull when lxc contaner was stopped not by 'vagrant halt' command and redir processes are still running.
+
+```shell
+$ vagrant redir kill
+```
+
+or for particular VM:
+
+```shell
+$ vagrant redir kill [<name>]
+```
+
+
+
+### pids
+
+Show stored redir pids and appropriate processes states
+This is helpful to diagnose are all redir processes running or some of them are not running.
+
+```shell
+$ vagrant redir pids
+```
+
+will show:
+
+```shell
+List of stored redir's pids of VM 'xdg':
+ pid: 16458; host_port: 8901; is_system_port: false; is_running: false
+ pid: 16472; host_port: 8908; is_system_port: false; is_running: false
+ pid: 16486; host_port: 8902; is_system_port: false; is_running: false
+ pid: 16444; host_port: 8900; is_system_port: false; is_running: false
+
+List of stored redir's pids of VM 'db1':
+ pid: 16519; host_port: 9000; is_system_port: false; is_running: false
+ pid: 16547; host_port: 9080; is_system_port: false; is_running: false
+ pid: 16533; host_port: 9001; is_system_port: false; is_running: false
+ pid: 16561; host_port: 9022; is_system_port: false; is_running: false
+```
+
+or for particular VM:
+
+```shell
+$ vagrant redir pids [<name>]
+```
+
+
+
+### ps
+
+Show pids of running redir processes grepped by VM's public IP
+
+```shell
+$ vagrant redir ps
+```
+
+will show: 
+
+```shell
+List of running redir's pids for VM 'xdg' grepped by public IP:
+ pid: 12637; host_port: 8900; is_system_port: false
+ pid: 12651; host_port: 8901; is_system_port: false
+ pid: 12665; host_port: 8908; is_system_port: false
+ pid: 12679; host_port: 8902; is_system_port: false
+
+List of running redir's pids for VM 'db1' grepped by public IP:
+ pid: 12712; host_port: 9000; is_system_port: false
+ pid: 12726; host_port: 9001; is_system_port: false
+ pid: 12740; host_port: 9080; is_system_port: false
+ pid: 12754; host_port: 9022; is_system_port: false
+```
+
+or for particular VM:
+
+```shell
+$ vagrant redir ps [<name>]
+```
+
+
+
+
+### status
+
+Show list of running redir processes by stored pids
+
+```shell
+$ vagrant redir status
+```
+
+
+or for particular VM:
+
+```shell
+$ vagrant redir status [<name>]
+```
+
+
+
+### up
+
+Setup port forwarding for vm(s).
+Same process vagrant starts on 'vagrant up' command.
+
+```shell
+$ vagrant redir pids
+```
+
+
+or for particular VM:
+
+```shell
+$ vagrant redir pids [<name>]
+```
+
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/st02tkh/vagrant-redir. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vagrant::Redir project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vagrant-redir/blob/master/CODE_OF_CONDUCT.md).

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/clean_test_dir

@@ -0,0 +1,5 @@
+#! /usr/bin/env bash
+
+this_dir="$(cd $(dirname "$0") && pwd)"
+proj_dir="$(cd "$this_dir/.." && pwd)"
+find "$proj_dir" -maxdepth 1 -type l -delete

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vagrant/redir"
+
+# 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(__FILE__)

data/bin/link_test_dir

@@ -0,0 +1,39 @@
+#! /usr/bin/env bash
+
+if [ -z "$1" ]; then
+    echo "Usage: $0 TGT_DIR"
+    echo "       TGT_DIR - a directory with Vagrantfile"
+    exit 100
+fi
+
+except_list=".git .gitignore .gitmodules bin lib spec Gemfile Gemfile.lock README README.md Puppetfile redir_map locales"
+
+this_dir="$(cd $(dirname "$0") && pwd)"
+proj_dir="$(cd "$this_dir/.." && pwd)"
+tgt_dir="$(cd "$1" && pwd)"
+
+function list_include_item {
+  local list="$1"
+  local item="$2"
+  if [[ $list =~ (^|[[:space:]])"$item"($|[[:space:]]) ]] ; then
+    # yes, list include item
+    result=0
+  else
+    result=1
+  fi
+  return $result
+}
+
+find "$tgt_dir" -mindepth 1 -maxdepth 1 | while read tgt_path; do
+    tgt_basename="$(basename "$tgt_path")"
+    if `list_include_item "$except_list" "$tgt_basename"` ; then
+      :
+    else 
+      (cd "$proj_dir" \
+       && ([ -L "$tgt_basename" ] \
+           && ln -sf "$tgt_basename" && rm "$tgt_basename"; : ) \
+       && ln -s "$tgt_path"
+      )
+      echo "$tgt_path -> $proj_dir/$tgt_basename"
+    fi
+done

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/lib/vagrant/redir/command/addr.rb

@@ -0,0 +1,60 @@
+require "log4r"
+require 'optparse'
+require "vagrant/redir/helper"
+
+module Vagrant
+  module Redir 
+    module Command
+      class Addr < Vagrant.plugin("2", :command)
+
+        include Vagrant::Redir::Helper
+
+        def initialize(argv, env)
+          super
+          @logger = Log4r::Logger.new("vagrant::redir::command::addr")
+          @argv
+          @env = env
+        end
+
+        def execute
+          return help if @argv.include?("-h") || @argv.include?("--help")
+
+          opts = OptionParser.new
+          argv = parse_options(opts)
+          @logger.debug("argv: #{argv}")
+          
+          if with_target_vms(argv) { }.count > 0
+            @env.ui.info I18n.t("vagrant_redir.command.addr.list_title")
+            with_target_vms(argv) do |vm|
+
+              pub_ip = vm.provider.capability(:public_address)
+
+              if vm.state.id != :running
+                raise ::Vagrant::Redir::Errors::NotRunning
+              end
+              if pub_ip == nil
+                raise ::Vagrant::Redir::Errors::Unknown
+              end
+
+              @env.ui.info I18n.t("vagrant_redir.command.addr.list_item", id: vm.id, name: vm.name, ip: pub_ip)
+
+            end
+          end
+        end
+
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant redir addr [<name>]"
+            opts.separator ""
+            opts.separator "Show VM's ID, name and public IP address"
+            opts.separator ""
+            opts.separator " <name> - optional virtual machine name"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant/redir/command/config.rb

@@ -0,0 +1,56 @@
+require "log4r"
+require 'optparse'
+require "vagrant/redir/helper"
+
+module Vagrant
+  module Redir 
+    module Command
+      class Config < Vagrant.plugin("2", :command)
+
+        include Vagrant::Redir::Helper
+
+        def initialize(argv, env)
+          super
+          @logger = Log4r::Logger.new("vagrant::redir::command::config")
+          @argv
+          @env = env
+        end
+
+        def execute
+          return help if @argv.include?("-h") || @argv.include?("--help")
+
+          opts = OptionParser.new
+          argv = parse_options(opts)
+          @logger.debug("argv: #{argv}")
+
+          with_target_vms(argv) do |vm|
+            if compile_forwarded_ports(vm.config).any?
+              @env.ui.info I18n.t("vagrant_redir.command.config.list_title", name: vm.name)
+              compile_forwarded_ports(vm.config).each do |record|
+                  r = record.delete(:id)
+                  s = record.collect do |k, v|
+                      "#{k}: #{v}"
+                  end.join(', ')
+                  @env.ui.info(" #{s}")
+              end
+              @env.ui.info("")
+            end
+          end
+        end
+
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant redir config [<name>]"
+            opts.separator ""
+            opts.separator "Show port forwarding configuration"
+            opts.separator ""
+            opts.separator " <name> - optional virtual machine name"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant/redir/command/down.rb

@@ -0,0 +1,47 @@
+require "log4r"
+require 'optparse'
+require "vagrant/redir/helper"
+
+module Vagrant
+  module Redir 
+    module Command
+      class Down < Vagrant.plugin("2", :command)
+        
+        include Vagrant::Redir::Helper
+
+        def initialize(argv, env)
+          super
+          @logger = Log4r::Logger.new("vagrant::redir::command::down")
+          @argv
+          @env = env
+        end
+
+        def execute
+          return help if @argv.include?("-h") || @argv.include?("--help")
+
+          opts = OptionParser.new
+          argv = parse_options(opts)
+          @logger.debug("argv: #{argv}")
+
+          with_target_vms(argv) do |vm|
+            @env.ui.info I18n.t("vagrant_redir.command.down.shutting_down_vm", name: vm.name)
+            ensure_killed_by_stored_pids(vm)
+          end
+        end
+
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant redir down [<name>]"
+            opts.separator ""
+            opts.separator "Shut down redir processes by stored pids and remove inactive stored pids"
+            opts.separator ""
+            opts.separator " <name> - optional virtual machine name"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant/redir/command/kill.rb

@@ -0,0 +1,47 @@
+require "log4r"
+require 'optparse'
+require "vagrant/redir/helper"
+
+module Vagrant
+  module Redir 
+    module Command
+      class Kill < Vagrant.plugin("2", :command)
+        
+        include Vagrant::Redir::Helper
+
+        def initialize(argv, env)
+          super
+          @logger = Log4r::Logger.new("vagrant::redir::command::kill")
+          @argv
+          @env = env
+        end
+
+        def execute
+          return help if @argv.include?("-h") || @argv.include?("--help")
+
+          opts = OptionParser.new
+          argv = parse_options(opts)
+          @logger.debug("argv: #{argv}")
+
+          with_target_vms(argv) do |vm|
+            @logger.debug "Killing redir processes for VM #{vm.name}:"
+            ensure_killed_by_ip(vm)
+          end
+        end
+
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant redir kill [<name>]"
+            opts.separator ""
+            opts.separator "Kill redir processes by stored pids and remove stoed pids"
+            opts.separator ""
+            opts.separator " <name> - optional virtual machine name"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+
+      end
+    end
+  end
+end