image_optimize 1.0.0 → 1.0.1

data/spec/image_bundle_spec.rb

@@ -0,0 +1,97 @@
+# Author: cary@rightscale.com
+# Copyright 2014 RightScale, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'image_bundle'))
+
+describe ImageOptimize::ImageBundleBase, "Image Bundle Utilities" do
+
+  describe "Base Class" do
+    it "can be created" do
+      ImageOptimize::ImageBundleBase.new("instance_client", "api_client")
+    end
+  end
+
+  describe "EC2 EBS Implementation" do
+    let(:instance_client) { double("instance_client") }
+    let(:api_client) { double("api_client") }
+
+    it "initializes" do
+      ImageOptimize::ImageBundleEc2EBS.any_instance.stub(:load_meta_data)
+      ib = ImageOptimize::ImageBundleEc2EBS.new(
+        "instance_client",
+        "api_client",
+        "aws_access_key",
+        "aws_secret_key"
+      )
+      ib.should_not == nil
+    end
+  end
+
+  describe "EC2 S3 Implementation" do
+    let(:instance_client) { double("instance_client") }
+    let(:api_client) { double("api_client") }
+
+    it "initializes" do
+      ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+      ib = ImageOptimize::ImageBundleEc2S3.new(
+        "instance_client",
+        "api_client",
+        "aws_access_key",
+        "aws_secret_key",
+        "aws_account_number",
+        "x509_key_file",
+        "x509_cert_file",
+        "s3_bucket"
+      )
+      ib.instance_variable_get(:@bundle_dir).should == "/mnt/ephemeral/bundle" # default value
+      ib.instance_variable_get(:@no_filter).should == nil
+    end
+
+    it "initializes with bundle dir" do
+      ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+      ib = ImageOptimize::ImageBundleEc2S3.new(
+        "instance_client",
+        "api_client",
+        "aws_access_key",
+        "aws_secret_key",
+        "aws_account_number",
+        "x509_key_file",
+        "x509_cert_file",
+        "s3_bucket",
+        "/mnt/ephemeral"
+      )
+      ib.instance_variable_get(:@bundle_dir).should == "/mnt/ephemeral"
+    end
+
+    it "initializes with no-filter option" do
+      ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+      ib = ImageOptimize::ImageBundleEc2S3.new(
+        "instance_client",
+        "api_client",
+        "aws_access_key",
+        "aws_secret_key",
+        "aws_account_number",
+        "x509_key_file",
+        "x509_cert_file",
+        "s3_bucket",
+        "/mnt/ephemeral",
+        "true"
+      )
+      ib.instance_variable_get(:@no_filter).should == true
+    end
+  end
+
+end

data/spec/image_optimizer_spec.rb

@@ -0,0 +1,194 @@
+# Author: cary@rightscale.com
+# Copyright 2014 RightScale, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'app', 'image_optimizer'))
+
+describe ImageOptimize::Optimizer, "Image Bundle Controller" do
+
+  before(:each) do
+    # dont log stuff
+    Logger.any_instance.stub(:info)
+    Logger.any_instance.stub(:error)
+    Logger.any_instance.stub(:debug)
+  end
+
+  it "requires aws_secret_key specified" do
+    ARGV.replace [
+      '--aws-access-key',"awsaccesskey",
+      '--aws-secret-key',"awssecretkey",
+      '--api-user',"someone@rightscale.com",
+      '--api-password',"supersecret",
+      '--aws-account-number',"8675309",
+
+      '--aws-image-type','S3',
+      '--aws-s3-bundle-directory', "/mnt/ephemeral/foo",
+      '--aws-s3-key-path', "/tmp/key/path",
+      '--aws-s3-cert-path', "/tmp/cert/path",
+      '--aws-s3-image-bucket', "myimagebucket.example.com",
+      '--aws-s3-bundle-no-filter'
+    ]
+    api_stub = double("ApiClient15", :log => nil, :get_client => nil)
+    bundler_stub = double("Bundler", :log => nil)
+    RightScale::ApiClient15.should_receive(:new).and_return(api_stub)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+    optimizer = ImageOptimize::Optimizer.new
+    optimizer.parse_args
+    optimizer.send(:setup_logging)
+    lambda{ optimizer.configure }.should_not raise_error
+  end
+
+  it "fails if no aws_secret_key is specified" do
+    optimizer = ImageOptimize::Optimizer.new
+    optimizer.parse_args
+    optimizer.send(:setup_logging)
+    lambda{ optimizer.configure }.should raise_error
+  end
+
+  it "can be created for EC2 EBS" do
+    ENV['API_USER_EMAIL']="someone@rightscale.com"
+    ENV['API_USER_PASSWORD']="supersecret"
+    ENV['AWS_SECRET_KEY']="awssecretkey"
+    ENV['AWS_ACCESS_KEY']="awsaccesskey"
+    @aws_s3_bundle_no_filter = true
+
+    api_stub = double("ApiClient15", :log => nil, :get_client => nil)
+    bundler_stub = double("Bundler", :log => nil)
+    RightScale::ApiClient15.should_receive(:new).and_return(api_stub)
+    ImageOptimize::ImageBundleEc2EBS.should_receive(:new).and_return(bundler_stub)
+    optimizer = ImageOptimize::Optimizer.new
+    optimizer.parse_args
+    optimizer.send(:setup_logging)
+    optimizer.configure
+  end
+
+  it "can be created for EC2 S3" do
+    ENV['API_USER_EMAIL']="someone@rightscale.com"
+    ENV['API_USER_PASSWORD']="supersecret"
+    ENV['AWS_SECRET_KEY']="awssecretkey"
+    ENV['AWS_ACCESS_KEY']="awsaccesskey"
+    ENV['AWS_ACCOUNT_NUMBER']="1234567890"
+
+    @aws_s3_bundle_no_filter = true
+
+    ARGV.replace [
+      '--aws-image-type','S3'
+    ]
+
+    api_stub = double("ApiClient15", :log => nil, :get_client => nil)
+    RightScale::ApiClient15.should_receive(:new).and_return(api_stub)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+    io = ImageOptimize::Optimizer.new
+    io.parse_args
+    io.send(:setup_logging)
+    io.configure
+
+    ib = io.instance_variable_get(:@image_util)
+  end
+
+  it "parses command-line parameters" do
+    ENV['API_USER_EMAIL']="someone@rightscale.com"
+    ENV['API_USER_PASSWORD']="supersecret"
+    ENV['AWS_SECRET_KEY']="awssecretkey"
+    ENV['AWS_ACCESS_KEY']="awsaccesskey"
+    ENV['AWS_ACCOUNT_NUMBER']="1234567890"
+    @aws_s3_image_bucket="deleteme"
+    key_path="foo"
+    cert_path="bar"
+    image_type = "EBS"
+    aws_s3_bundle_directory = "/mnt/ephemeral/foo"
+    @aws_s3_bundle_no_filter = true
+
+    image_type = "S3"
+
+    ARGV.replace [
+      '--aws-image-type', image_type,
+      '--aws-s3-bundle-directory',aws_s3_bundle_directory,
+      '--aws-s3-key-path', key_path,
+      '--aws-s3-cert-path', cert_path,
+      '--aws-s3-image-bucket', @aws_s3_image_bucket,
+      '--aws-s3-bundle-no-filter'
+    ]
+    optimizer = ImageOptimize::Optimizer.new
+    args = optimizer.parse_args
+    args[:api_user].should == ENV['API_USER_EMAIL']
+    args[:api_password].should == ENV['API_USER_PASSWORD']
+    args[:aws_secret_key].should == ENV['AWS_SECRET_KEY']
+    args[:aws_access_key].should == ENV['AWS_ACCESS_KEY']
+    args[:aws_account_number].should == ENV['AWS_ACCOUNT_NUMBER']
+    args[:aws_s3_image_bucket].should == @aws_s3_image_bucket
+    args[:aws_image_type].should == image_type
+    args[:aws_s3_bundle_directory].should == aws_s3_bundle_directory
+    args[:aws_s3_bundle_no_filter].should == @aws_s3_bundle_no_filter
+    args[:aws_s3_key_path].should == key_path
+    args[:aws_s3_cert_path].should == cert_path
+  end
+
+  it "processes the run command without errors" do
+    ENV['API_USER_EMAIL']="someone@rightscale.com"
+    ENV['API_USER_PASSWORD']="supersecret"
+    ENV['AWS_SECRET_KEY']="awssecretkey"
+    ENV['AWS_ACCESS_KEY']="awsaccesskey"
+    ENV['AWS_ACCOUNT_NUMBER']="1234567890"
+
+    aws_s3_image_bucket = "deleteme"
+    key_path="foo"
+    cert_path="bar"
+    image_type = "S3"
+    aws_s3_bundle_directory = "/mnt/ephemeral/foo"
+    @aws_s3_bundle_no_filter = true
+
+    ARGV.replace [
+      '--aws-image-type', image_type,
+      '--aws-s3-bundle-directory', aws_s3_bundle_directory,
+      '--aws-s3-key-path', key_path,
+      '--aws-s3-cert-path', cert_path,
+      '--aws-s3-image-bucket', aws_s3_image_bucket,
+      '--aws-s3-bundle-no-filter',
+      '--no-cleanup'
+    ]
+
+    # mock some stuff
+    api_stub = double("ApiClient15", :log => nil, :get_client => nil)#right_api_client_stub)
+    RightScale::ApiClient15.should_receive(:new).and_return(api_stub)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:load_meta_data)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:snapshot_instance)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:register_image)
+    ImageOptimize::ImageBundleEc2S3.any_instance.stub(:add_image_to_next_instance)
+
+    # run some stuff
+    optimizer = ImageOptimize::Optimizer.new
+    optimizer.should_receive(:prepare_image).at_most(0).times
+    optimizer.should_receive(:unique_name)
+    optimizer.run
+
+    # check argument parsing
+    args =  optimizer.instance_variable_get(:@args)
+    args[:api_user].should == ENV['API_USER_EMAIL']
+    args[:api_password].should == ENV['API_USER_PASSWORD']
+    args[:aws_secret_key].should == ENV['AWS_SECRET_KEY']
+    args[:aws_access_key].should == ENV['AWS_ACCESS_KEY']
+    args[:aws_account_number].should == ENV['AWS_ACCOUNT_NUMBER']
+    args[:aws_s3_image_bucket].should == aws_s3_image_bucket
+    args[:aws_image_type].should == image_type
+    args[:aws_s3_bundle_directory].should == aws_s3_bundle_directory
+    args[:aws_s3_bundle_no_filter].should == @aws_s3_bundle_no_filter
+    args[:aws_s3_key_path].should == key_path
+    args[:aws_s3_cert_path].should == cert_path
+
+  end
+
+
+end

data/test/image_optimize_test.rb

@@ -0,0 +1,50 @@
+# Author: cary@rightscale.com
+# Copyright 2014 RightScale, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+describe "Image Optimize Functional Test" do
+
+  # you must own this bucket
+  # do to a known issue in the EC2 tools, the bucket must already exist
+  S3_BUCKET_NAME = "cp2-pub-cached-images"
+
+  before(:all) do
+    #XXX: this should to be detected from VM, but simply set in env before running the test
+    # ENV['IMAGE_TYPE'] = 'S3'
+    ec2_zone = `curl http://169.254.169.254/latest/meta-data/placement/availability-zone/`
+    @region =  /(.*\-.*\-[1-9]*)/.match(ec2_zone).captures.first
+    puts "Detected EC2 region #{@region}"
+  end
+
+  it "creates an instance facing api connection" do
+    cwd = File.dirname(__FILE__)
+    secrets_dir = "#{cwd}/../.secrets"
+
+    command = ". #{secrets_dir}/creds; bin/image_optimize --aws-image-type #{ENV['IMAGE_TYPE']} --aws-s3-image-bucket #{S3_BUCKET_NAME} --aws-s3-key-path #{secrets_dir}/x509.key --aws-s3-cert-path #{secrets_dir}/x509.cert --aws-s3-bundle-directory /mnt/ephemeral/bundle --verbose --no-cleanup"
+
+    puts "COMMAND: #{command}"
+    output = ""
+    IO.popen("#{command} 2>&1") do |data|
+      while line = data.gets
+        puts "\e[33m#{line}\e[0m" # 33 = yellow text
+        output << line
+      end
+    end
+    process_status = $?
+    puts "OUTPUT: #{output}"
+    process_status.exitstatus.should == 0
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_optimize
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -110,10 +110,40 @@ dependencies:
 description: Bundle a running server into a new image that will be used on next launch
 email:
 - cary@rightscale.com
-executables: []
+executables:
+- image_optimize
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/image_optimize
+- image_optimize.gemspec
+- lib/api_client_15.rb
+- lib/app/image_optimizer.rb
+- lib/image_bundle.rb
+- lib/image_bundle/image_bundle_base.rb
+- lib/image_bundle/image_bundle_ec2.rb
+- lib/image_bundle/image_bundle_ec2_ebs.rb
+- lib/image_bundle/image_bundle_ec2_s3.rb
+- lib/mixins/command.rb
+- lib/mixins/common.rb
+- rightscale/rightscript.sh
+- setup.sh
+- spec/api_client_spec.rb
+- spec/command_spec.rb
+- spec/image_bundle_ec2_spec.rb
+- spec/image_bundle_spec.rb
+- spec/image_optimizer_spec.rb
+- test/image_optimize_test.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -126,17 +156,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1039956523122922011
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1039956523122922011
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Bundle a running server into a new image that will be used on next launch
-test_files: []
-has_rdoc: 
+test_files:
+- spec/api_client_spec.rb
+- spec/command_spec.rb
+- spec/image_bundle_ec2_spec.rb
+- spec/image_bundle_spec.rb
+- spec/image_optimizer_spec.rb
+- test/image_optimize_test.rb