lita-enhance 0.9.0

data/spec/data/stg-web01.json

@@ -0,0 +1,89 @@
+{
+  "name": "stg-web01",
+  "chef_environment": "_default",
+  "run_list": [
+    "role[web]"
+  ],
+  "normal": {
+    "tags": [
+
+    ]
+  },
+  "default": {
+  },
+  "override": {
+  },
+  "automatic": {
+    "ipaddress": "10.254.74.122",
+    "macaddress": "22:00:0A:FE:4A:80",
+    "ec2": {
+      "ami_id": "ami-f6ec60c6",
+      "ami_launch_index": "0",
+      "ami_manifest_path": "ubuntu-us-west-2/images/ubuntu-lucid-10.04-amd64-server-20120403.manifest.xml",
+      "block_device_mapping_ami": "sda1",
+      "block_device_mapping_ephemeral0": "sda2",
+      "block_device_mapping_root": "/dev/sda1",
+      "block_device_mapping_swap": "sda3",
+      "hostname": "ip-10-254-74-122.us-west-2.compute.internal",
+      "instance_action": "none",
+      "instance_id": "i-fe4cddcc",
+      "instance_type": "m1.small",
+      "kernel_id": "aki-ace26f9c",
+      "local_hostname": "ip-10-254-74-122.us-west-2.compute.internal",
+      "local_ipv4": "10.254.74.122",
+      "mac": "22:00:0A:FE:4A:80",
+      "metrics_vhostmd": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
+      "network_interfaces_macs": {
+        "22:00:0a:fe:4a:80": {
+          "device_number": "0",
+          "local_hostname": "ip-10-254-74-122.us-west-2.compute.internal",
+          "local_ipv4s": "10.254.74.122",
+          "mac": "22:00:0a:fe:4a:80",
+          "owner_id": "622089341825",
+          "public_hostname": "ec2-54-214-188-38.us-west-2.compute.amazonaws.com",
+          "public_ipv4s": "54.214.188.38"
+        }
+      },
+      "placement_availability_zone": "us-west-2b",
+      "profile": "default-paravirtual",
+      "public_hostname": "ec2-54-214-188-38.us-west-2.compute.amazonaws.com",
+      "public_ipv4": "54.214.188.38",
+      "reservation_id": "r-994854ac",
+      "security_groups": [
+        "web"
+      ],
+      "userdata": null
+    },
+    "cloud": {
+      "public_ips": [
+        "54.214.188.38"
+      ],
+      "private_ips": [
+        "10.254.74.122"
+      ],
+      "public_ipv4": "54.214.188.38",
+      "public_hostname": "ec2-54-214-188-38.us-west-2.compute.amazonaws.com",
+      "local_ipv4": "10.254.74.122",
+      "local_hostname": "ip-10-254-74-122.us-west-2.compute.internal",
+      "provider": "ec2"
+    },
+    "cloud_v2": {
+      "public_ipv4_addrs": [
+        "54.214.188.38"
+      ],
+      "local_ipv4_addrs": [
+        "10.254.74.122"
+      ],
+      "provider": "ec2",
+      "public_hostname": "ec2-54-214-188-38.us-west-2.compute.amazonaws.com",
+      "local_hostname": "ip-10-254-74-122.us-west-2.compute.internal",
+      "public_ipv4": "54.214.188.38",
+      "local_ipv4": "10.254.74.122"
+    },
+    "hostname": "stg-web01",
+    "machinename": "stg-web01",
+    "fqdn": "stg-web01.example.com",
+    "domain": "example.com"
+  }
+}
+

data/spec/data/web01.json

@@ -0,0 +1,89 @@
+{
+  "name": "web01",
+  "chef_environment": "_default",
+  "run_list": [
+    "role[web]"
+  ],
+  "normal": {
+    "tags": [
+
+    ]
+  },
+  "default": {
+  },
+  "override": {
+  },
+  "automatic": {
+    "ipaddress": "10.254.74.123",
+    "macaddress": "22:00:0A:FE:4A:81",
+    "ec2": {
+      "ami_id": "ami-f6ec60c6",
+      "ami_launch_index": "0",
+      "ami_manifest_path": "ubuntu-us-west-2/images/ubuntu-lucid-10.04-amd64-server-20120403.manifest.xml",
+      "block_device_mapping_ami": "sda1",
+      "block_device_mapping_ephemeral0": "sda2",
+      "block_device_mapping_root": "/dev/sda1",
+      "block_device_mapping_swap": "sda3",
+      "hostname": "ip-10-254-74-123.us-west-2.compute.internal",
+      "instance_action": "none",
+      "instance_id": "i-fe4cddcd",
+      "instance_type": "m1.small",
+      "kernel_id": "aki-ace26f9c",
+      "local_hostname": "ip-10-254-74-123.us-west-2.compute.internal",
+      "local_ipv4": "10.254.74.123",
+      "mac": "22:00:0A:FE:4A:81",
+      "metrics_vhostmd": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
+      "network_interfaces_macs": {
+        "22:00:0a:fe:4a:81": {
+          "device_number": "0",
+          "local_hostname": "ip-10-254-74-123.us-west-2.compute.internal",
+          "local_ipv4s": "10.254.74.123",
+          "mac": "22:00:0a:fe:4a:81",
+          "owner_id": "622089341825",
+          "public_hostname": "ec2-54-214-188-39.us-west-2.compute.amazonaws.com",
+          "public_ipv4s": "54.214.188.39"
+        }
+      },
+      "placement_availability_zone": "us-west-2b",
+      "profile": "default-paravirtual",
+      "public_hostname": "ec2-54-214-188-39.us-west-2.compute.amazonaws.com",
+      "public_ipv4": "54.214.188.39",
+      "reservation_id": "r-994854ac",
+      "security_groups": [
+        "web"
+      ],
+      "userdata": null
+    },
+    "cloud": {
+      "public_ips": [
+        "54.214.188.39"
+      ],
+      "private_ips": [
+        "10.254.74.123"
+      ],
+      "public_ipv4": "54.214.188.39",
+      "public_hostname": "ec2-54-214-188-39.us-west-2.compute.amazonaws.com",
+      "local_ipv4": "10.254.74.123",
+      "local_hostname": "ip-10-254-74-123.us-west-2.compute.internal",
+      "provider": "ec2"
+    },
+    "cloud_v2": {
+      "public_ipv4_addrs": [
+        "54.214.188.39"
+      ],
+      "local_ipv4_addrs": [
+        "10.254.74.123"
+      ],
+      "provider": "ec2",
+      "public_hostname": "ec2-54-214-188-39.us-west-2.compute.amazonaws.com",
+      "local_hostname": "ip-10-254-74-123.us-west-2.compute.internal",
+      "public_ipv4": "54.214.188.39",
+      "local_ipv4": "10.254.74.123"
+    },
+    "hostname": "web01",
+    "machinename": "web01",
+    "fqdn": "web01.example.com",
+    "domain": "example.com"
+  }
+}
+

data/spec/lita/handlers/enhance/chef_indexer_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Lita::Handlers::Enhance::ChefIndexer do
+  include_context 'mocks'
+  include_context 'redis'
+
+  let(:indexer) { described_class.new(redis, {}) }
+
+  it 'should be able to create Node from a Chef::Node' do
+    node = indexer.node_from_chef_node(west2_chef_node)
+
+    expect(node.name).to eq('box01')
+    expect(node.dc).to eq('us-west-2b')
+    expect(node.environment).to eq('_default')
+    expect(node.fqdn).to eq('box01.example.com')
+    expect(node.last_seen_at.to_f).to be_within(5).of(Time.now.to_f)
+  end
+end

data/spec/lita/handlers/enhance/enhancer_example.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.shared_examples 'an enhancer' do
+  it 'should be able to render a node' do
+    expect(enhancer.render(nodes.first, 1)).to eq('*box01*')
+    expect(enhancer.render(nodes.first, 2)).to eq('*box01 (us-west-2b)*')
+  end
+
+  it 'should render an old node slightly differently' do
+    node = nodes.first
+    node.last_seen_at = Time.now - 24 * 60 * 60
+
+    expect(enhancer.render(node, 1)).to eq('¿box01?')
+    expect(enhancer.render(node, 2)).to eq('¿box01 (us-west-2b)?')
+  end
+end

data/spec/lita/handlers/enhance/enhancers/hostname_enhancer_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+require 'lita/handlers/enhance/enhancer_example'
+
+describe Lita::Handlers::Enhance::HostnameEnhancer do
+  include_context 'indexed'
+
+  let(:enhancer) { Lita::Handlers::Enhance::HostnameEnhancer.new(redis) }
+  let(:sub_klass) { Lita::Handlers::Enhance::Substitution }
+
+  it_should_behave_like 'an enhancer'
+
+  it 'should enhance a string with an EC2 public hostname in it' do
+    message = 'before ec2-54-214-188-37.us-west-2.compute.amazonaws.com after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...56, '*box01*')]
+  end
+
+  it 'should enhance a string with an EC2 short public hostname in it' do
+    message = 'before ec2-54-214-188-37 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...24, '*box01*')]
+  end
+
+  it 'should enhance a string with an EC2 localhost hostname in it' do
+    message = 'before ip-10-254-74-121.us-west-2.compute.internal after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...50, '*box01*')]
+  end
+
+  it 'should enhance a string with an EC2 localhost hostname in it' do
+    message = 'before ip-10-254-74-121 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...23, '*box01*')]
+  end
+
+  it 'should enhance a string with a custom long hostname in it' do
+    message = 'before box01.example.com after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...24, '*box01*')]
+  end
+
+  it 'should enhance a string with a custom short hostname in it' do
+    message = 'before box01 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to eq [sub_klass.new(7...12, '*box01*')]
+  end
+
+  it 'should not enhance a string with an unknown hostname' do
+    message = 'foo.bar.com'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to be_empty
+  end
+
+  it 'should return a custom response to to_s' do
+    expect(enhancer.to_s).to match /short hostnames.*long hostnames indexed/
+  end
+end

data/spec/lita/handlers/enhance/enhancers/instance_id_enhancer_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+require 'lita/handlers/enhance/enhancer_example'
+
+describe Lita::Handlers::Enhance::InstanceIdEnhancer do
+  include_context 'indexed'
+
+  let(:enhancer) { Lita::Handlers::Enhance::InstanceIdEnhancer.new(redis) }
+  let(:sub_klass) { Lita::Handlers::Enhance::Substitution }
+
+  it_should_behave_like 'an enhancer'
+
+  it 'should enhance a string with EC2 instance IDs in it' do
+    message = 'before i-fe4cddcb i-f4ff6aff after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to contain_exactly(
+      sub_klass.new(7...17, '*box01*'),
+      sub_klass.new(18...28, '*box02*')
+    )
+  end
+
+  it 'should not enhance an unrecognized EC2 instance ID' do
+    message = 'i-f00bac12'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to be_empty
+  end
+
+  it 'should return a custom response to to_s' do
+    expect(enhancer.to_s).to match /instance IDs indexed/
+  end
+end

data/spec/lita/handlers/enhance/enhancers/ip_enhancer_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+require 'lita/handlers/enhance/enhancer_example'
+
+describe Lita::Handlers::Enhance::IpEnhancer do
+  include_context 'indexed'
+
+  let(:enhancer) { Lita::Handlers::Enhance::IpEnhancer.new(redis) }
+  let(:sub_klass) { Lita::Handlers::Enhance::Substitution }
+
+  it_should_behave_like 'an enhancer'
+
+  it 'should enhance a string with EC2 external IPs in it' do
+    message = 'before 54.214.188.37 184.169.229.1 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to contain_exactly(
+      sub_klass.new(7...20, '*box01*'),
+      sub_klass.new(21...34, '*box02*')
+    )
+  end
+
+  it 'should enhance a string with EC internal IPs in it' do
+    message = 'before 10.254.74.121 10.196.75.1 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to contain_exactly(
+      sub_klass.new(7...20, '*box01*'),
+      sub_klass.new(21...32, '*box02*')
+    )
+  end
+
+  it 'should enhance a string with Linode IPs in it' do
+    message = 'before 192.155.85.2 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to contain_exactly(
+      sub_klass.new(7...19, '*box03*')
+    )
+  end
+
+  it 'should not enhance an unrecognized IP' do
+    message = '127.0.0.1'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to be_empty
+  end
+
+  it 'should return a custom response to to_s' do
+    expect(enhancer.to_s).to match /IPs indexed/
+  end
+end

data/spec/lita/handlers/enhance/enhancers/mac_address_enhancer_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+require 'lita/handlers/enhance/enhancer_example'
+
+describe Lita::Handlers::Enhance::MacAddressEnhancer do
+  include_context 'indexed'
+
+  let(:enhancer) { Lita::Handlers::Enhance::MacAddressEnhancer.new(redis) }
+  let(:sub_klass) { Lita::Handlers::Enhance::Substitution }
+
+  it_should_behave_like 'an enhancer'
+
+  it 'should enhance a string with MAC addresses in it' do
+    message = 'before 22:00:0A:FE:4A:79 F2:3C:91:56:A2:00 after'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to contain_exactly(
+      sub_klass.new(7...24, '*box01*'),
+      sub_klass.new(25...42, '*box03*')
+    )
+  end
+
+  it 'should not enhance an unrecognized MAC address' do
+    message = '00:00:00:00:00:00'
+    substitutions = enhancer.enhance!(message, 1)
+    expect(substitutions).to be_empty
+  end
+
+  it 'should return a custom response for to_s' do
+    expect(enhancer.to_s).to match /MAC addresses indexed/
+  end
+end
+

data/spec/lita/handlers/enhance/node_index_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+require 'lita/handlers/enhance/node_index'
+
+describe Lita::Handlers::Enhance::NodeIndex do
+  include_context 'mocks'
+  include_context 'redis'
+
+  let(:index) { Lita::Handlers::Enhance::NodeIndex.new(redis, 'fqdn') }
+  let(:node) { nodes.first }
+
+  it 'should be able to add a node to the index' do
+    index['127.0.0.1'] = node
+  end
+
+  it 'should be able to find a node in the index' do
+    index['127.0.0.1'] = node
+    new_node = index['127.0.0.1']
+    expect(new_node.name).to eq(node.name)
+  end
+
+  it 'should return nil if no node is found in the index' do
+    expect(index['127.0.0.5']).to be_nil
+  end
+
+  it 'should be able to return its size' do
+    expect(index.size).to eq(0)
+    nodes.each do |node|
+      index[node.name] = node
+    end
+    expect(index.size).to eq(nodes.length)
+  end
+end

data/spec/lita/handlers/enhance/node_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Lita::Handlers::Enhance::Node do
+  include_context 'mocks'
+  include_context 'redis'
+
+  let(:node) do
+    described_class.new.tap do |n|
+      n.name = 'box01'
+      n.dc = 'us-west-2b'
+      n.environment = '_default'
+      n.fqdn = 'box01.example.com'
+      n.last_seen_at = Time.now
+    end
+  end
+
+  it "should be able to save it's state in a JSON blob" do
+    node_json = node.as_json
+    expect(node_json).to include(
+      name: 'box01',
+      dc: 'us-west-2b',
+      environment: '_default',
+      fqdn: 'box01.example.com'
+    )
+    expect(node_json[:last_seen_at]).to_not be_nil
+  end
+
+  it "should be able to store and load itself" do
+    node.store!(redis)
+
+    new_node = Lita::Handlers::Enhance::Node.load(redis, 'box01')
+    expect(new_node).to_not be_nil
+    expect(new_node.name).to eq(node.name)
+    expect(new_node.last_seen_at).to be_kind_of(Time)
+  end
+
+  it 'should be able to render itself at differing levels of detail' do
+    expect(node.render(1)).to eq('box01')
+    expect(node.render(2)).to eq('box01 (us-west-2b)')
+    expect(node.render(3)).to eq('box01 (us-west-2b, _default)')
+    expect(node.render(4)).to match /box01 \(us-west-2b, _default, last seen .*\)/
+    expect(node.render(5)).to match /box01\.example\.com \(us-west-2b, _default, last seen .*\)/
+  end
+
+  it 'should know if it is old' do
+    expect(node.old?).to be(false)
+
+    node.last_seen_at = Time.now - 24 * 60 * 60
+    expect(node.old?).to be(true)
+  end
+end