ami_spec 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c50eed3429c33081ff25fc9d4695b10c1f3696c839a53f2da7ebaca9457333f8
-  data.tar.gz: 20a87adad2bfa8a80ae3f6c4794d08515612a4da46590a61656ac3c02608a1a0
+  metadata.gz: 4504c60fd0ce24f40be03e192159fcc9c8509cddbc2642cb0c8c50e351a7c7fa
+  data.tar.gz: 8fc38e659fb6436b8ad37467564445de49c92940991d3f8b820d1b2f6927355a
 SHA512:
-  metadata.gz: d89d294411139f9645536b67aeab0e47eb744a9aad698c9e3807ac29b5bbf0589c6dbbfa4dc0250a938801878dae8ce673cb765d11c0b932d6e10d94f062ae80
-  data.tar.gz: 1e0a0a653a5f792e7f126a891f0b6aa73a2aadcf2d3ecda8059cb5df0136337cf719e359cefd79d47227ee0dcd16c37f63adbced9a00b20441f6613b7dfd58e3
+  metadata.gz: 1a86bbfccdfbbe323eea7cea45bc9450d41626d3a40ed456a41b4228ef4eb1b211e23268a024dbecd81ebb768a06f00ac19e99f31387ce14e6b32635c99886cf
+  data.tar.gz: 65effb5f2d0a7053c645c79b9ffa0c42ca93c4ee4183cdfbc7ab909263affb431d54ba0ea7f0dcb339bc5f3b81466ed765393d644886910b499e6a8df501c673

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
  - 1.9.3
  - 2.1.8
  - 2.2.4
+script: bundle exec rake spec

data/README.md

@@ -110,9 +110,23 @@ For bug fixes, documentation changes, and small features:
 4. Push to the branch (git push origin my-new-feature)
 5. Create a new Pull Request
 
+## Running tests
+
+Use the following command to run non-integration tests:
+```
+bundle exec rake spec
+```
+
+If you're working on the `WaitForRC` feature you can run it's integration tests by first bringing up the containers, then executing the integration tests:
+```
+docker-compose -f spec/containers/docker-compose.yml up -d
+bundle exec rspec . --tag integration
+docker-compose -f spec/containers/docker-compose.yml down
+```
+
 ## Maintainers
 
-Patrick Robinson (@nemski)
+Patrick Robinson (@patrobinson)
 
 ## License
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--tag ~integration"
+end
 
 task :default => :spec

data/lib/ami_spec/version.rb

@@ -1,3 +1,3 @@
 module AmiSpec
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/ami_spec/wait_for_rc.rb

@@ -2,15 +2,39 @@ require 'net/ssh'
 
 module AmiSpec
   class WaitForRC
-    def self.wait(ip_address, user, key)
-      Net::SSH.start(ip_address, user, keys: [key], paranoid: false) do |ssh|
-        # Wait for SystemV to start
-        # This only works for Ubuntu with upstart.
-        # Detecting OS and Release will need something like this
-        # https://github.com/mizzy/specinfra/blob/master/lib/specinfra/helper/detect_os/debian.rb
-        ssh.exec 'while /usr/sbin/service rc status | grep -q "^rc start/running, process"; do sleep 1; done'
+    def self.wait(ip_address, user, key, port=22)
+      Net::SSH.start(ip_address, user, keys: [key], paranoid: false, port: port) do |ssh|
+        distrib_stdout = ""
+        # Determine the OS family
+        ssh.exec!("source /etc/*release && echo -n $DISTRIB_ID && echo -n $ID") do |channel, stream, data|
+          distrib_stdout << data if stream == :stdout
+        end
+        if distrib_stdout == "Ubuntu"
+          codename_stdout = ""
+          ssh.exec!("source /etc/*release && echo -n $DISTRIB_CODENAME") do |channel, stream, data|
+            codename_stdout << data if stream == :stdout
+          end
+          if codename_stdout == "trusty"
+            ssh.exec 'while /usr/sbin/service rc status | grep -q "^rc start/running, process"; do sleep 1; done'
+          elsif codename_stdout == "xenial"
+            ssh.exec 'while /usr/sbin/service rc status >/dev/null; do sleep 1; done'
+          else
+            puts "WARNING: Only Ubuntu trusty and xenial supported and we detected '#{codename_stdout}'. --wait-for-rc has no effect."
+          end
+        elsif distrib_stdout == "amzn"
+          version_stdout = ""
+          ssh.exec!("source /etc/*release && echo -n $VERSION_ID") do |channel, stream, data|
+            version_stdout << data if stream == :stdout
+          end
+          if version_stdout =~ %r{201[0-9]{1}\.[0-9]+}
+            ssh.exec 'while initctl status rc |grep -q "^rc start/running"; do sleep 1; done'
+          else
+            puts "WARNING: Only Amazon Linux 1 is supported and we detected '#{version_stdout}'. --wait-for-rc has no effect."
+          end
+        else
+          puts "WARNING: Only Ubuntu and Amazon linux are supported and we detected '#{distrib_stdout}'. --wait-for-rc has no effect."
+        end
       end
     end
   end
 end
-

data/spec/containers/Dockerfile.amazon_linux

@@ -0,0 +1,9 @@
+FROM amazonlinux:1
+
+RUN yum install -y upstart openssh-server && yum clean all
+ADD rc.conf /etc/init/rc.conf
+
+COPY ami-spec.pub /root/.ssh/authorized_keys
+COPY sshd_config /etc/ssh/sshd_config
+
+CMD ["/bin/bash", "-c", "exec /sbin/init"]

data/spec/containers/Dockerfile.trusty

@@ -0,0 +1,8 @@
+FROM ubuntu-upstart:trusty
+
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update && apt-get install -y openssh-server && apt-get clean
+
+COPY ami-spec.pub /root/.ssh/authorized_keys
+
+EXPOSE 22

data/spec/containers/Dockerfile.xenial

@@ -0,0 +1,22 @@
+FROM ubuntu:xenial
+
+RUN cd /lib/systemd/system/sysinit.target.wants/; ls | grep -v systemd-tmpfiles-setup | xargs rm -f $1 \
+rm -f /lib/systemd/system/multi-user.target.wants/*;\
+rm -f /etc/systemd/system/*.wants/*;\
+rm -f /lib/systemd/system/local-fs.target.wants/*; \
+rm -f /lib/systemd/system/sockets.target.wants/*udev*; \
+rm -f /lib/systemd/system/sockets.target.wants/*initctl*; \
+rm -f /lib/systemd/system/basic.target.wants/*;\
+rm -f /lib/systemd/system/anaconda.target.wants/*; \
+rm -f /lib/systemd/system/plymouth*; \
+rm -f /lib/systemd/system/systemd-update-utmp*;
+
+RUN apt-get update && apt-get install -y openssh-server dbus && apt-get clean
+
+RUN systemctl set-default multi-user.target
+
+COPY ami-spec.pub /root/.ssh/authorized_keys
+
+EXPOSE 22
+
+CMD ["/bin/bash", "-c", "exec /sbin/init --log-target=journal 3>&1"]

data/spec/containers/README.md

@@ -0,0 +1,5 @@
+## Integration test containers
+
+This directory is used to create containers that can be used to test the `WaitForRC` class. Because they require upstart/systemd to exist we have to install and start the init environment. We also setup SSH so that we can simple call the `wait` function and have it SSH to our container to execute.
+
+Refer to the [README](../../README.md#running-tests) for how to execute them.

data/spec/containers/ami-spec

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAwWn2++lylp8RcHzy7H9QpYli3nxLDh769DDbnb9cw2UDd9OH
+6JZKaT3xe3IbMr39SmkGlOygkBmeH43VxAkiVJv3awDPRU0UvDyUvCsbaYj1/cOS
+8Vxr7ENExoiKkengcg6k3mFj65ooJ1pf8RoXuj+0+YU0fgejuR/M4x6V8GKFCJhU
+wFmRs3mcoCx0EiJtTx40IW87uOQUruDX5HcgTUInRhyRxltNrXJaap1weMGpIA/o
+Bo8foOx1Os9o3YKQlkPF4iqk2AVJ4FZGbMay0cIq3075Jeig6bdlIhRpYA+w+SAI
+y/yT/K3U1ciQqKtPgahGEyihrh7Ks2F2FSLhdwIDAQABAoIBABWt/QNLrY54kgnb
+15buxmlntu9dW0Rf8J1ChLtv4cP9JKBf05IcloapbNH7flT3utaGYzh6NZ0xYeoD
+ifyJUZHOUbNqydDozPQ0ji9xXYc81OX28Beh1m8LM0BVucKVRpVCUvSiUgLsqqeO
+l8Z8uEAmN/DoH3QpAw8TI3Ip0YC6OHA2aRV9PXuDnR5OTdBPOBj33Fdtf0rUAk41
+UFe/BHFyACfTK05+bcQz9DvRV/H+SnBeOCqDie1eNDnEgza4NS2cnBUCogKsaCrY
+gV06pivS2aHsK5CuNB1lcZi1tVf3DnDwPvFWqLLG9PIHaevPDpDURECirCrpCWJT
+VSHm7KECgYEA4K5jSna4Jzo9FlHzF+yGEju5QwEJTjnhunNw1FpcgPAddFQ4hs3w
+0EhyPlZyf3vwhfdH4vBhTLjRTrOF2SIvSSPwrkWlAhaluVvpVRFd/ncYW4kAVwhQ
+15/ZBtvu8OQnKeeztsLlkEi4ik3cKjeXyeDQReb2Guvc6IM4fr6ZrlkCgYEA3F/S
+uJr04UgzX0cQuNLX7uXz6oeyJupwFkTuAhvLcHDsDHFkP1M9zfFzg5aEcQungz/l
+5s/vFJmfLBrzhSoYY1T9PDdLwEL/JKaxhKNEV9lExF4exMui6QPWdTMA8ndvB7r5
+Ur85X8scH1qJo99fsEmNmG5O72PGXmltOB0sNE8CgYEApeuCPYIweh+C7xGzkE5F
+r/9Uz4tbYN5TuMn5X4gfWcR4K+jqGXrJxDZLz4ctZMGVHIlBF/DmGa8+On1OccvR
+2ZRl73xU35bz6U9bn0uE+x7d6PLiQmNMt/8+WNdfu5rw5PxLdcK1nnhldxUKak7F
+k/qmM4jc44Kcj0QgG1EL0nkCgYAFbV61KSvKuIp7WDazNo4W1hbxubHLf46PHdd2
+udSCymUl0U0UuioVflLH9NcCKbVQaCxzSL+slDP1VByXNPgwyhEKgJoe/Adokaph
+h9vRBgrJgz/ivNkgP/XyIPVvAz36xMILJaZ2E3x30TT+kiu7HbSdAmpzPtPN027b
+KOzDxQKBgEv2OvEtpvpv9DgPHs9Mq4haTh2o8c8JW7kwHqbbZOZjZ/4daEh89FhH
+gjvJV5NjaNhFqBWTnNfjSr4o09WFDoQyVwEUrWNJXXZmsjOHqMDT/kwVoAsld1tO
+N+JW6/4M+EMYvF39yWzdQn/U3A1gZIfzAC6S3HUCi9BgKLBMKEN3
+-----END RSA PRIVATE KEY-----

data/spec/containers/ami-spec.pub

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDBafb76XKWnxFwfPLsf1CliWLefEsOHvr0MNudv1zDZQN304folkppPfF7chsyvf1KaQaU7KCQGZ4fjdXECSJUm/drAM9FTRS8PJS8KxtpiPX9w5LxXGvsQ0TGiIqR6eByDqTeYWPrmignWl/xGhe6P7T5hTR+B6O5H8zjHpXwYoUImFTAWZGzeZygLHQSIm1PHjQhbzu45BSu4NfkdyBNQidGHJHGW02tclpqnXB4wakgD+gGjx+g7HU6z2jdgpCWQ8XiKqTYBUngVkZsxrLRwirfTvkl6KDpt2UiFGlgD7D5IAjL/JP8rdTVyJCoq0+BqEYTKKGuHsqzYXYVIuF3

data/spec/containers/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3'
+services:
+  xenial:
+    build:
+      context: .
+      dockerfile: Dockerfile.xenial
+    ports:
+      - "1122:22"
+    # --security-opt seccomp=unconfined --tmpfs /run --tmpfs /run/lock -v /sys/fs/cgroup:/sys/fs/cgroup:ro
+    security_opt:
+      - seccomp:unconfined
+    tmpfs:
+      - /run
+      - /run/lock
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  trusty:
+    build:
+      context: .
+      dockerfile: Dockerfile.trusty
+    ports:
+      - "1123:22"
+  amazon_linux:
+    build:
+      context: .
+      dockerfile: Dockerfile.amazon_linux
+    ports:
+      - "1124:22"

data/spec/containers/rc.conf

@@ -0,0 +1,17 @@
+# rc - System V runlevel compatibility
+#
+# This task runs the old sysv-rc runlevel scripts.  It
+# is usually started by the telinit compatibility wrapper.
+#
+# Do not edit this file directly. If you want to change the behaviour,
+# please create a file rc.override and put your changes there.
+
+start on runlevel [0123456]
+
+stop on runlevel [!$RUNLEVEL]
+
+task
+
+export RUNLEVEL
+console output
+exec /etc/rc.d/rc $RUNLEVEL

data/spec/containers/sshd_config

@@ -0,0 +1,17 @@
+HostKey /etc/ssh/ssh_host_rsa_key
+HostKey /etc/ssh/ssh_host_ecdsa_key
+HostKey /etc/ssh/ssh_host_ed25519_key
+SyslogFacility AUTHPRIV
+AuthorizedKeysFile	.ssh/authorized_keys
+PasswordAuthentication no
+ChallengeResponseAuthentication no
+UsePAM yes
+X11Forwarding yes
+PrintLastLog yes
+UsePrivilegeSeparation sandbox
+AcceptEnv LANG LC_CTYPE LC_NUMERIC LC_TIME LC_COLLATE LC_MONETARY LC_MESSAGES
+AcceptEnv LC_PAPER LC_NAME LC_ADDRESS LC_TELEPHONE LC_MEASUREMENT
+AcceptEnv LC_IDENTIFICATION LC_ALL LANGUAGE
+AcceptEnv XMODIFIERS
+Subsystem	sftp	/usr/libexec/openssh/sftp-server
+PermitRootLogin yes

data/spec/wait_for_rc_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe AmiSpec::WaitForRC, integration: true do
+  let(:private_key_file) { File.expand_path(File.join('..', 'containers', 'ami-spec'), __FILE__) }
+  context 'xenial server' do
+    let(:ssh_port) { 1122 }
+    it 'executes without printing any errors' do
+      expect { described_class.wait("localhost", "root", private_key_file, ssh_port) }.to_not output.to_stdout
+    end
+  end
+
+  context 'trusty server' do
+    let(:ssh_port) { 1123 }
+    it 'executes without printing any errors' do
+      expect { described_class.wait("localhost", "root", private_key_file, ssh_port) }.to_not output.to_stdout
+    end
+  end
+
+  context 'amazon linux server' do
+    let(:ssh_port) { 1124 }
+    it 'executes without printing any errors' do
+      expect { described_class.wait("localhost", "root", private_key_file, ssh_port) }.to_not output.to_stdout
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ami_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Patrick Robinson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -135,7 +135,17 @@ files:
 - lib/ami_spec/wait_for_ssh.rb
 - spec/ami_spec_spec.rb
 - spec/aws_instance_spec.rb
+- spec/containers/Dockerfile.amazon_linux
+- spec/containers/Dockerfile.trusty
+- spec/containers/Dockerfile.xenial
+- spec/containers/README.md
+- spec/containers/ami-spec
+- spec/containers/ami-spec.pub
+- spec/containers/docker-compose.yml
+- spec/containers/rc.conf
+- spec/containers/sshd_config
 - spec/spec_helper.rb
+- spec/wait_for_rc_spec.rb
 - spec/wait_for_ssh_spec.rb
 homepage: https://github.com/envato/ami-spec
 licenses: []
@@ -163,5 +173,15 @@ summary: Acceptance testing your AMIs
 test_files:
 - spec/ami_spec_spec.rb
 - spec/aws_instance_spec.rb
+- spec/containers/Dockerfile.amazon_linux
+- spec/containers/Dockerfile.trusty
+- spec/containers/Dockerfile.xenial
+- spec/containers/README.md
+- spec/containers/ami-spec
+- spec/containers/ami-spec.pub
+- spec/containers/docker-compose.yml
+- spec/containers/rc.conf
+- spec/containers/sshd_config
 - spec/spec_helper.rb
+- spec/wait_for_rc_spec.rb
 - spec/wait_for_ssh_spec.rb