landrush-ip 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjViY2VmMDhiMTViZjkyNWI4NGYxNjU2YjQ3MWU2ZGIzN2UwOTViZA==
+  data.tar.gz: !binary |-
+    ZmY0M2RhODM2ZjA2NTA0N2ZmMGM2MjVhNDIwYTU4N2ZiNDhmMDU0Zg==
+SHA512:
+  metadata.gz: !binary |-
+    MGNkNWFkZGEzYWJkY2FjNGRlY2E1ZGVjOTIwMjczMGUyODZjZDA5OGI2ZDJj
+    NTI2ZDg1NTE5MzdkMDhhZGVhMzE4MTljNTRmZmUxMTljZGFhMjdiZTk4N2Qw
+    MWViNjBmMWNlMjA3MTA0YWZkOTI0ZWJhZDdiNmMxYjI3ZjZhZWM=
+  data.tar.gz: !binary |-
+    MGUyYzRlOGM5MGJkNGM5OTkxOTIwMDhlMTdhMDE1ZTM0ZTNjN2NmMDc4ODA1
+    OGZmNWM2MDhkZjM3M2VhNDdkZGVmOTg2OTkyMGFmZDQ4MGE3Nzk4ODAxZGQ0
+    YzUzMzI0ZDkwNWFmYzNjMTBjOWFmYmQyODI1ZjI1MWQ4OGYyY2I=

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 paul@neverbland.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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Paul Werelds
+
+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,161 @@
+# LandrushIp
+
+[![Build Status](https://travis-ci.org/Werelds/landrush-ip.svg?branch=master)](https://travis-ci.org/Werelds/landrush-ip)
+
+This gem is a capability plugin for Vagrant, used in Landrush (but perfectly usable outside Landrush).
+
+Its sole purpose is to provide a unified interface for grabbing a machine's IP addresses, independent of the OS.
+
+While most operating systems do have multiple tools available to do this, they all work differently and none are standard across OS families.
+ On Linux one might have `ip` or `ifconfig` for example.
+ Neither is the de facto standard and in most cases, neither is installed by default in a minimal install.
+  
+To get around this, this plugin includes a tiny binary written in Go, that produces identical output on every OS.
+ Therefore, any OS that is supported by Go can be supported by this plugin.
+
+## Operating System Support
+
+Currently, only Linux is supported.
+Once we're happy with the functionality and mechanics, this will be expanded to BSD, Windows and whatever else we can support.
+
+## Usage
+
+When used with Landrush, it will automatically be activated and install itself.
+
+Without Landrush, one has to enable it explicitly via `landrush_ip.override` if auto-installation is desired.
+
+Other plugins can use the provided capabilities to check if it is installed and/or install it.
+
+Example config with VirtualBox to force installation:
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.define 'mybox' do |machine|
+    machine.vm.box = 'debian/jessie64'
+    machine.vm.network 'private_network', type: 'dhcp'
+    
+    machine.landrush_ip.override = true
+    
+    machine.vm.provider :virtualbox do |provider, _|
+      provider.memory = 512
+      provider.cpus = 2
+    end
+  end
+end
+```
+
+## Capabilities
+
+This plugin exposes the following _Guest_ capabilities:
+
+- `landrush_ip_installed` returns a boolean to indicate whether Landrush is installed and up to date with the installed version of the plugin.
+- `landrush_ip_install` installs the binary.
+- `landrush_ip_get` returns all IP addresses of the machine in an array of hashes. Each hash has the following structure: `{ 'name' => 'lo', 'ipv4' => '127.0.0.1', 'ipv6' => '::1' }`.
+
+Do note that the IP addresses are returned as strings; they are not yet cast to `IPAddr` or any other form, this is left entirely up to the consumer.
+
+## Binary
+
+The binary will be installed in various locations:
+
+- Linux: `/usr/local/sbin/landrush-ip`
+
+It has the following options:
+
+- `-h` displays the usage/help
+- `-v` displays the version
+- `-json` returns the output in JSON format
+- `-yaml` returns the output in YAML format
+
+By default, it returns the output in TSV (Tab Separated Values) format.
+ First column is interface name, second is IPv4 address and third is IPv6 address.
+ 
+The JSON and YAML formats output objects and hashes respectively, that have a `name`, `ipv4` and `ipv6` key.
+
+No filtering is done with any of the formats, so any interface that has no assigned IP will still show up.
+ It's left up to consumer to filter that out.
+ Same goes for the order in which they are returned, they are returned as returned by the OS.
+ 
+The following examples are all from OS X (Darwin)
+
+Plain text (`landrush-ip`):
+```
+lo0	127.0.0.1	fe80::1
+gif0
+stf0
+en0	192.168.0.102
+en1
+en2
+fw0
+p2p0
+awdl0
+bridge0
+```
+
+YAML (`landrush-ip -yaml`):
+```yaml
+- name: lo0
+  ipv4: 127.0.0.1
+  ipv6: fe80::1
+- name: gif0
+  ipv4: ""
+  ipv6: ""
+- name: stf0
+  ipv4: ""
+  ipv6: ""
+- name: en0
+  ipv4: 192.168.0.102
+  ipv6: ""
+- name: en1
+  ipv4: ""
+  ipv6: ""
+- name: en2
+  ipv4: ""
+  ipv6: ""
+- name: fw0
+  ipv4: ""
+  ipv6: ""
+- name: p2p0
+  ipv4: ""
+  ipv6: ""
+- name: awdl0
+  ipv4: ""
+  ipv6: ""
+- name: bridge0
+  ipv4: ""
+  ipv6: ""
+```
+
+JSON (`landrush-ip -json`):
+```json
+[
+  {"name":"lo0","ipv4":"127.0.0.1","ipv6":"fe80::1"},
+  {"name":"gif0","ipv4":"","ipv6":""},
+  {"name":"stf0","ipv4":"","ipv6":""},
+  {"name":"en0","ipv4":"192.168.0.102","ipv6":""},
+  {"name":"en1","ipv4":"","ipv6":""},
+  {"name":"en2","ipv4":"","ipv6":""},
+  {"name":"fw0","ipv4":"","ipv6":""},
+  {"name":"p2p0","ipv4":"","ipv6":""},
+  {"name":"awdl0","ipv4":"","ipv6":""},
+  {"name":"bridge0","ipv4":"","ipv6":""}
+]
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+ Run `rake test` to run the tests.
+
+A `Vagrantfile` is present to run the plugin in if you so desire.
+ Make sure to execute in context of the Gem bundle: `bundle exec vagrant <command>`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Werelds/landrush-ip.
+ 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/lib/landrush-ip.rb

@@ -0,0 +1,19 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'Landrush IP must be run within Vagrant'
+end
+
+require 'landrush-ip/plugin'
+require 'landrush-ip/errors'
+
+require 'pathname'
+
+module LandrushIp
+  def self.source_root
+    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
+  I18n.load_path << File.expand_path('locales/en.yml', source_root)
+  I18n.reload!
+end

data/lib/landrush-ip/action/install.rb

@@ -0,0 +1,42 @@
+module LandrushIp
+  module Action
+    class Install
+      def initialize(app, env, hook)
+        @app  = app
+        @env  = env
+        @hook = hook
+      end
+
+      def installed?
+        @machine.guest.capability(:landrush_ip_installed)
+      end
+
+      def override?
+        @machine.config.landrush_ip.override
+      end
+
+      def enabled?
+        override? || (@machine.config.key('landrush') && @machine.config.landrush.enabled)
+      end
+
+      def install
+        @env[:ui].warn I18n.t('vagrant.config.landrush_ip.not_installed')
+
+        raise Vagrant::LandrushIp::Error, :cannot_install unless @machine.guest.capability(:landrush_ip_install)
+      end
+
+      def call(env)
+        @app.call(env)
+        @env = env
+        @machine = env[:machine]
+
+        # Auto install in one of 2 cases:
+        # - landrush-ip is forcibly enabled via the override setting
+        # - Landrush is installed and enabled
+        install if enabled? && !installed?
+
+        @env[:ui].info I18n.t('vagrant.config.landrush_ip.not_enabled') unless enabled?
+      end
+    end
+  end
+end

data/lib/landrush-ip/cap/linux/landrush_ip_get.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+module LandrushIp
+  module Cap
+    module Linux
+      module LandrushIpGet
+        def self.landrush_ip_get(machine)
+          result = ''
+          machine.communicate.execute(command) do |type, data|
+            result << data if type == :stdout
+          end
+
+          YAML.load(result)
+        end
+
+        def self.command
+          '/usr/local/bin/landrush-ip -yaml'
+        end
+      end
+    end
+  end
+end

data/lib/landrush-ip/cap/linux/landrush_ip_install.rb

@@ -0,0 +1,37 @@
+module LandrushIp
+  module Cap
+    module Linux
+      module LandrushIpInstall
+        def self.determine_binary(uname)
+          if uname =~ /(x86_64|ia64|amd64)/i
+            'landrush-ip-linux_amd64'
+          elsif uname =~ /(arm)/i
+            'landrush-ip-linux_arm'
+          elsif uname =~ /(i386|i686)/i
+            'landrush-ip-linux_386'
+          else
+            raise LandrushIp::Error, :unsupported_arch
+          end
+        end
+
+        def self.landrush_ip_install(machine)
+          result = ''
+          machine.communicate.execute('uname -mrs') do |type, data|
+            result << data if type == :stdout
+          end
+
+          binary = determine_binary result
+
+          machine.communicate.tap do |comm|
+            guest_path = '/usr/local/bin/landrush-ip'
+            host_path  = File.expand_path("util/dist/#{binary}", LandrushIp.source_root)
+
+            comm.upload(host_path, '/tmp/landrush-ip')
+            comm.sudo("mv /tmp/landrush-ip #{guest_path}")
+            comm.sudo("chmod +x #{guest_path}", error_check: false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/landrush-ip/cap/linux/landrush_ip_installed.rb

@@ -0,0 +1,20 @@
+module LandrushIp
+  module Cap
+    module Linux
+      module LandrushIpInstalled
+        def self.landrush_ip_installed(machine)
+          result = ''
+          machine.communicate.execute(command) do |type, data|
+            result << data if type == :stdout
+          end
+
+          result.strip! == LandrushIp::VERSION
+        end
+
+        def self.command
+          '/usr/local/bin/landrush-ip -v || echo 0'
+        end
+      end
+    end
+  end
+end

data/lib/landrush-ip/config.rb

@@ -0,0 +1,31 @@
+require 'vagrant'
+require 'vagrant/errors'
+require 'vagrant/util/template_renderer'
+
+module LandrushIp
+  class Config < Vagrant.plugin('2', :config)
+    attr_accessor :override
+
+    DEFAULTS = {
+      override: false
+    }.freeze
+
+    def initialize
+      @override = UNSET_VALUE
+      @logger   = Log4r::Logger.new('vagrantplugins::landruship::config')
+    end
+
+    def default_options(new_values = {})
+      @default_options = {} if @default_options == UNSET_VALUE
+      @default_options.merge! new_values
+    end
+
+    def override?
+      @override
+    end
+
+    def finalize!
+      @default_options = {} if @default_options == UNSET_VALUE
+    end
+  end
+end

data/lib/landrush-ip/errors.rb

@@ -0,0 +1,5 @@
+module LandrushIp
+  class Error < Vagrant::Errors::VagrantError
+    error_namespace('vagrant.config.landrush_ip.errors')
+  end
+end

data/lib/landrush-ip/plugin.rb

@@ -0,0 +1,38 @@
+module LandrushIp
+  class Plugin < Vagrant.plugin('2')
+    name 'LandrushIp'
+
+    description <<-DESC
+      This plugin allows for finer grained control over which IP to use as external address.
+      Particularly when you use DHCP and have multiple interfaces (virtual or otherwise) this often is a problem.
+    DESC
+
+    config(:landrush_ip) do
+      require 'landrush-ip/config'
+      Config
+    end
+
+    guest_capability('linux', 'landrush_ip_installed') do
+      require 'landrush-ip/cap/linux/landrush_ip_installed'
+      Cap::Linux::LandrushIpInstalled
+    end
+
+    guest_capability('linux', 'landrush_ip_install') do
+      require 'landrush-ip/cap/linux/landrush_ip_install'
+      Cap::Linux::LandrushIpInstall
+    end
+
+    guest_capability('linux', 'landrush_ip_get') do
+      require 'landrush-ip/cap/linux/landrush_ip_get'
+      Cap::Linux::LandrushIpGet
+    end
+
+    require 'landrush-ip/action/install'
+
+    %w(up reload).each do |action|
+      action_hook(:landrush_ip, "machine_action_#{action}".to_sym) do |hook|
+        hook.before(Landrush::Action::RedirectDns, Action::Install, :provision)
+      end
+    end
+  end
+end

data/lib/landrush-ip/version.rb

@@ -0,0 +1,3 @@
+module LandrushIp
+  VERSION = '0.2.0'.freeze
+end

data/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  vagrant:
+    config:
+      landrush_ip:
+        not_enabled: "Landrush IP override not enabled and Landrush was not found, nothing to do."
+        not_installed: "Landrush IP not installed in guest yet (or it's an outdated version). Installing now."
+        errors:
+          unsupported_arch: "Unsupported architecture"
+          cannot_install: "Unable to install landrush-ip"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: landrush-ip
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Paul Werelds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- paul@neverbland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/landrush-ip.rb
+- lib/landrush-ip/action/install.rb
+- lib/landrush-ip/cap/linux/landrush_ip_get.rb
+- lib/landrush-ip/cap/linux/landrush_ip_install.rb
+- lib/landrush-ip/cap/linux/landrush_ip_installed.rb
+- lib/landrush-ip/config.rb
+- lib/landrush-ip/errors.rb
+- lib/landrush-ip/plugin.rb
+- lib/landrush-ip/version.rb
+- locales/en.yml
+- util/dist/landrush-ip-linux_386
+- util/dist/landrush-ip-linux_amd64
+- util/dist/landrush-ip-linux_arm
+homepage: https://github.com/Werelds/landrush-ip
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Capability plugin for Vagrant that allows more fine grained control over
+  selecting IP addresses
+test_files: []