canals 0.8.0

data/spec/canals/options_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+require 'canals/options'
+require 'psych'
+
+describe Canals::CanalOptions do
+
+  let(:name) { "example" }
+  let(:remote_host) { "www.example.com" }
+  let(:remote_port) { 1234 }
+  let(:local_port)  { 4321 }
+  let(:bind_address)  { "1.2.3.4" }
+  let(:hostname)  { "nat.example.com" }
+  let(:user)  { "user" }
+  let(:pem)  { "/tmp/file.pem" }
+
+  describe "name" do
+    it "contains 'name'" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.name).to eq name
+    end
+
+    it "raises error when 'name' is not availble" do
+      args = {"remote_host" => remote_host, "remote_port" => remote_port}
+      expect{Canals::CanalOptions.new(args)}.to raise_error(Canals::CanalOptionError)
+    end
+  end
+
+  describe "remote_host" do
+    it "contains 'remote_host'" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.remote_host).to eq remote_host
+    end
+
+    it "raises error when 'remote_host' is not availble" do
+      args = {"name" => name, "remote_port" => remote_port}
+      expect{Canals::CanalOptions.new(args)}.to raise_error(Canals::CanalOptionError)
+    end
+  end
+
+  describe "remote_port" do
+    it "contains 'remote_port'" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.remote_port).to eq remote_port
+    end
+
+    it "raises error when 'remote_port' is not availble" do
+      args = {"name" => name, "remote_host" => remote_host}
+      expect{Canals::CanalOptions.new(args)}.to raise_error(Canals::CanalOptionError)
+    end
+
+    it "transforms remote_port to int if given in string" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => '1234'}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.remote_port).to eq 1234
+      expect(opt.local_port).to eq 1234
+    end
+
+  end
+
+  describe "local_port" do
+    it "returns 'local_port' if 'local_port' is availble" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.local_port).to eq local_port
+    end
+
+    it "returns 'remote_port' for 'local_port' if 'local_port' isn't given" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.local_port).to eq remote_port
+    end
+
+    it "transforms local_port to int if given in string" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => "4321"}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.local_port).to eq 4321
+    end
+  end
+
+  describe "bind_address" do
+    it "returns 'bind_address' if 'bind_address' is availble" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port, "bind_address" => bind_address}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.bind_address).to eq bind_address
+    end
+
+    it "returns 'Canals::CanalOptions::BIND_ADDRESS' for 'bind_address' if 'bind_address' isn't given" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.bind_address).to eq Canals::CanalOptions::BIND_ADDRESS
+    end
+  end
+
+  describe "environment variables" do
+    context "without env" do
+
+      before(:each) do
+        expect(Canals.repository).to receive(:environment).and_return(nil)
+      end
+
+      it "returns 'hostname/user/pem' if availble" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "hostname" => hostname, "user" => user, "pem" => pem}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.hostname).to eq hostname
+        expect(opt.user).to eq user
+        expect(opt.pem).to eq pem
+      end
+
+      it "returns nil under env_name" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.env_name).to be nil
+      end
+
+      it "constructs proxy value" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "hostname" => hostname, "user" => user, "pem" => pem}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.proxy).to eq "-i #{pem} #{user}@#{hostname}"
+      end
+
+      it "constructs proxy value, no pem" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "hostname" => hostname, "user" => user}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.proxy).to eq "#{user}@#{hostname}"
+      end
+    end
+
+    context "with env" do
+      let(:env_name) { "env" }
+
+      before(:each) do
+        env = double("environment")
+
+        expect(Canals.repository).to receive(:environment).with(env_name).and_return(env)
+        allow(env).to receive(:hostname).and_return(hostname)
+        allow(env).to receive(:user).and_return(user)
+        allow(env).to receive(:pem).and_return(pem)
+      end
+
+      it "returns 'hostname/user/pem' from env" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "env" => env_name}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.hostname).to eq hostname
+        expect(opt.user).to eq user
+        expect(opt.pem).to eq pem
+      end
+
+      it "returns environment name under env_name" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "env" => env_name}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.env_name).to eq env_name
+      end
+
+      it "constructs proxy value" do
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "env" => env_name}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.proxy).to eq "-i #{pem} #{user}@#{hostname}"
+      end
+
+      it "returns allows overshadowing of env" do
+        overshadow_hostname = "*hostname*"
+        overshadow_user = "*user*"
+        overshadow_pem = "/tmp/overshadow.pem"
+
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "env" => env_name, "hostname" => overshadow_hostname, "user" => overshadow_user, "pem" => overshadow_pem}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.hostname).to eq overshadow_hostname
+        expect(opt.user).to eq overshadow_user
+        expect(opt.pem).to eq overshadow_pem
+        expect(opt.env_name).to eq env_name
+      end
+
+      it "constructs proxy value with overshadowing" do
+        overshadow_hostname = "*hostname*"
+        args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "env" => env_name, "hostname" => overshadow_hostname}
+        opt = Canals::CanalOptions.new(args)
+        expect(opt.proxy).to eq "-i #{pem} #{user}@#{overshadow_hostname}"
+      end
+    end
+  end
+
+
+  describe "to_yaml" do
+    it "dumps remote_port as int" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => '1234'}
+      yaml = Canals::CanalOptions.new(args).to_yaml
+      reparsed = Psych.load(yaml)
+      expect(reparsed["remote_port"]).to eq 1234
+      expect(reparsed["local_port"]).to eq 1234
+    end
+
+    it "dumps local_port as int" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => "4321"}
+      yaml = Canals::CanalOptions.new(args).to_yaml
+      reparsed = Psych.load(yaml)
+      expect(reparsed["local_port"]).to eq 4321
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.expand_path("..", __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'canals'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: canals
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Ido Abramovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: A console utility to help build ssh tunnels and keep them up
+email: canals.sf17@abramovich.info
+executables:
+- canal
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rvmrc"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/canals.sh
+- bin/canal
+- canals.gemspec
+- lib/canals.rb
+- lib/canals/cli.rb
+- lib/canals/cli/environment.rb
+- lib/canals/cli/helpers.rb
+- lib/canals/cli/list.rb
+- lib/canals/cli/session.rb
+- lib/canals/cli/setup.rb
+- lib/canals/config.rb
+- lib/canals/core.rb
+- lib/canals/core_ext/shell_colors.rb
+- lib/canals/core_ext/string.rb
+- lib/canals/environment.rb
+- lib/canals/options.rb
+- lib/canals/repository.rb
+- lib/canals/session.rb
+- lib/canals/tools/assets.rb
+- lib/canals/tools/completion.rb
+- lib/canals/version.rb
+- spec/canals/environment_spec.rb
+- spec/canals/options_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/idoa01/canals
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: canals
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Eases the process of creating and managing SSH tunnels
+test_files:
+- spec/canals/environment_spec.rb
+- spec/canals/options_spec.rb
+- spec/spec_helper.rb