aws_minecraft 0.1.0

data/lib/aws_minecraft/upload_helper.rb

@@ -0,0 +1,23 @@
+require_relative 'mine_config'
+require 'net/scp'
+
+module AWSMine
+  # Main wrapper for Uploading files and the world
+  class UploadHelper
+    def initialize
+      @config = MineConfig.new
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger.const_get(@config.loglevel)
+    end
+
+    def upload_files(ip)
+      Net::SCP.start(ip, 'ec2-user') do |scp|
+        scp.upload!(@config.upload_path,
+                    '/home/ec2-user/data',
+                    recursive: true) do |_, name, sent, total|
+          @logger.info("#{name}: #{sent}/#{total}")
+        end
+      end
+    end
+  end
+end

data/lib/aws_minecraft/version.rb

@@ -0,0 +1,5 @@
+module AWSMine
+  class AWSMine
+    VERSION = '0.1.0'.freeze
+  end
+end

data/spec/aws_helper_spec.rb

@@ -0,0 +1,98 @@
+require 'aws_minecraft/aws_helper'
+require 'fakefs/spec_helpers'
+require 'spec_helper'
+require 'aws-sdk'
+
+describe AWSMine::AWSHelper do
+  include_context 'with aws minecraft'
+  let(:ec2_client) { instance_double(Aws::EC2::Client) }
+  let(:ec2_resource) { instance_double(Aws::EC2::Resource) }
+  let(:sg) { instance_double(Aws::EC2::SecurityGroup) }
+  let(:ec2) { instance_double(Aws::EC2::Instance) }
+  let(:ec2s) { instance_double(Aws::EC2::Instances) }
+  let(:client) { instance_double(Aws::Client) }
+  let(:state) { instance_double(Aws::EC2::Types::InstanceState) }
+
+  subject do |s|
+    s = described_class.new
+    s.ec2_client = ec2_client
+    s.ec2_resource = ec2_resource
+    s
+  end
+
+  describe '#initialize' do
+    it 'should be an instance of MineConfig' do
+      expect(subject).instance_of? AWSMine::AWSHelper
+    end
+  end
+
+  describe '#create_ec2' do
+    it 'should create an ec2 instance' do
+      expect(ec2_client).to receive(:describe_key_pairs).with(key_names: ['minecraft_keys'])
+      expect(ec2_resource).to receive(:create_security_group).with(dry_run: false,
+                                                                   group_name: 'mine_group',
+                                                                   description: 'minecraft_group')
+        .and_return(sg)
+      expect(sg).to receive(:authorize_ingress)
+      expect(sg).to receive(:id).and_return('sg-1')
+      expect(ec2_resource).to receive(:create_instances)
+        .with(dry_run: false,
+              image_id: 'ami-ea26ce85',
+              key_name: 'minecraft_keys',
+              min_count: 1,
+              max_count: 1,
+              instance_type: 't2.nano',
+              monitoring: { enabled: true },
+              security_group_ids: ['sg-1'],
+              user_data: "ICAgICAgICAgICEjL2Jpbi9iYXNo\n")
+        .and_return([ec2])
+      expect(ec2_resource).to receive(:client).and_return(client)
+      expect(ec2).to receive(:id).exactly(4).times.and_return('ec2-id')
+      expect(client).to receive(:wait_until).with(:instance_status_ok, instance_ids: ['ec2-id'])
+      expect(ec2_resource).to receive(:instances).with(instance_ids: ['ec2-id']).and_return([ec2])
+      expect(ec2).to receive(:public_ip_address).twice.and_return('1.2.3.4')
+      expect(subject.create_ec2).to eq(['1.2.3.4', 'ec2-id'])
+    end
+  end
+
+  describe '#terminate_ec2' do
+    it 'should terminate an ec2 instance' do
+      expect(ec2_client).to receive(:terminate_instances).with(dry_run: false,
+                                                               instance_ids: ['ec2-id'])
+      expect(ec2_resource).to receive(:client).and_return(client)
+      expect(client).to receive(:wait_until).with(:instance_terminated, instance_ids: ['ec2-id'])
+      subject.terminate_ec2('ec2-id')
+    end
+  end
+
+  describe '#stop_ec2' do
+    it 'should stop an ec2 instance' do
+      expect(ec2_client).to receive(:stop_instances).with(dry_run: false,
+                                                          instance_ids: ['ec2-id'])
+      expect(ec2_resource).to receive(:client).and_return(client)
+      expect(client).to receive(:wait_until).with(:instance_stopped, instance_ids: ['ec2-id'])
+      subject.stop_ec2('ec2-id')
+    end
+  end
+
+  describe '#start_ec2' do
+    it 'should start an ec2 instance' do
+      expect(ec2_client).to receive(:start_instances).with(dry_run: false,
+                                                           instance_ids: ['ec2-id'])
+      expect(ec2_resource).to receive(:client).and_return(client)
+      expect(client).to receive(:wait_until).with(:instance_running, instance_ids: ['ec2-id'])
+      expect(ec2_resource).to receive(:instances).with(instance_ids: ['ec2-id']).and_return([ec2])
+      expect(ec2).to receive(:public_ip_address).twice.and_return('1.2.3.4')
+      expect(subject.start_ec2('ec2-id')).to eq('1.2.3.4')
+    end
+  end
+
+  describe '#state' do
+    it 'should return the state of an existing instance' do
+      expect(ec2_resource).to receive(:instances).with(instance_ids: ['ec2-id']).and_return([ec2])
+      expect(ec2).to receive(:state).and_return(state)
+      expect(state).to receive(:name).and_return('running')
+      expect(subject.state('ec2-id')).to eq('running')
+    end
+  end
+end

data/spec/awsmine_spec.rb

@@ -0,0 +1,134 @@
+require 'aws_minecraft'
+require 'fakefs/spec_helpers'
+require 'spec_helper'
+
+describe AWSMine::AWSMine, fakefs: true do
+  include_context 'with aws minecraft'
+  let(:db) { instance_double(AWSMine::DBHelper) }
+  let(:aws) { instance_double(AWSMine::AWSHelper) }
+  let(:ssh) { instance_double(AWSMine::SSHHelper) }
+  let(:upload) { instance_double(AWSMine::UploadHelper) }
+  subject do |s|
+    s = described_class.new
+    s.aws_helper = aws
+    s.db_helper = db
+    s.upload_helper = upload
+    s.ssh_helper = ssh
+    s
+  end
+
+  describe '#create_instance' do
+    it 'should create an instance if it does not exists' do
+      expect(db).to receive(:instance_exists?).and_return(false)
+      expect(aws).to receive(:create_ec2).and_return(['1.2.3.4', 'i-asdf'])
+      expect(db).to receive(:store_instance).with('1.2.3.4', 'i-asdf')
+      subject.create_instance
+    end
+    it 'should return status and ip of instance if it already exists' do
+      expect(db).to receive(:instance_exists?).and_return(true)
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(aws).to receive(:state).and_return('running')
+      subject.create_instance
+    end
+  end
+
+  describe '#start_instance' do
+    it 'should start an instance if it exists' do
+      expect(db).to receive(:instance_exists?).and_return(true)
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(aws).to receive(:start_ec2).with('i-asdf').and_return('2.3.4.5')
+      expect(db).to receive(:update_instance).with('2.3.4.5', 'i-asdf')
+      subject.start_instance
+    end
+    it 'should return if instance does not exist' do
+      expect(db).to receive(:instance_exists?).and_return(false)
+      subject.start_instance
+    end
+  end
+
+  describe '#stop_instance' do
+    it 'should stop an instance if it exists' do
+      expect(db).to receive(:instance_exists?).and_return(true)
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(aws).to receive(:stop_ec2).with('i-asdf').and_return('2.3.4.5')
+      subject.stop_instance
+    end
+    it 'should return if instance does not exist' do
+      expect(db).to receive(:instance_exists?).and_return(false)
+      subject.stop_instance
+    end
+  end
+
+  describe '#terminate_instance' do
+    it 'should terminate an instance if it exists and delete it from the db' do
+      expect(db).to receive(:instance_exists?).and_return(true)
+      allow($stdin).to receive(:gets) { 'y' }
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(aws).to receive(:terminate_ec2).with('i-asdf')
+      expect(db).to receive(:remove_instance)
+      subject.terminate_instance
+    end
+    it 'should return if user chooses to not to terminate the instance' do
+      expect(db).to receive(:instance_exists?).and_return(true)
+      allow($stdin).to receive(:gets) { 'n' }
+      subject.terminate_instance
+    end
+    it 'should return if there are no instances' do
+      expect(db).to receive(:instance_exists?).and_return(false)
+      subject.terminate_instance
+    end
+  end
+
+  describe '#start_server' do
+    it 'should start a server' do
+      name = 'dunny'
+      cmd = "cd /home/ec2-user/data && ../tmux-2.2/tmux new -d -s #{AWSMine::AWSMine::MINECRAFT_SESSION_NAME} " \
+            "'echo eula=true > eula.txt && java -jar #{name} nogui'"
+      expect(subject).to receive(:remote_exec).with(cmd)
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      subject.start_server(name)
+    end
+  end
+
+  describe '#attach_to_server' do
+    it 'should attach to a running server' do
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(ssh).to receive(:attach_to_server).with('1.2.3.4')
+      subject.attach_to_server
+    end
+
+    # TODO: There are a lot more things to cover here. Like, ssh expection.
+    # Or if the db doesn't exists. Or the server is not running.
+  end
+
+  describe '#init_db' do
+    it 'should initialize the db' do
+      expect(db).to receive(:init_db)
+      subject.init_db
+    end
+  end
+
+  describe '#upload_files' do
+    it 'should upload files from the specified location in the config.yml file' do
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(upload).to receive(:upload_files).with('1.2.3.4')
+      subject.upload_files
+    end
+  end
+
+  describe '#remote_exec' do
+    it 'should be able to exectue cmd on an instance' do
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(ssh).to receive(:remote_exec).with('1.2.3.4', 'test_cmd')
+      subject.remote_exec('test_cmd')
+    end
+  end
+
+  describe '#ssh' do
+    it 'should be able to ssh into a running instance' do
+      expect(db).to receive(:instance_details).and_return(['1.2.3.4', 'i-asdf'])
+      expect(ssh).to receive(:ssh).with('1.2.3.4')
+      subject.ssh
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,18 @@
+require 'aws_minecraft/mine_config'
+require 'fakefs/spec_helpers'
+require 'spec_helper'
+
+describe AWSMine::MineConfig do
+  include_context 'with aws minecraft'
+  describe '#initialize', fakefs: true do
+    let(:mineconfig) { AWSMine::MineConfig.new }
+    it 'should be an instance of MineConfig' do
+      expect(mineconfig).instance_of? AWSMine::MineConfig
+    end
+
+    it 'correctly setup variables which are loaded from the config file' do
+      expect(mineconfig.loglevel).to eq('ERROR')
+      expect(mineconfig.upload_path).to eq('/drop')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# Require pp must be before fakefs. Otherwise there is an error:'superclass mismatch for class File'
+require 'pp'
+require 'fakefs/spec_helpers'
+require 'aws-sdk'
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers, fakefs: true
+end
+
+shared_examples 'with aws minecraft' do
+  before(:all) do
+    # Loading metadata for AWS before FakeFS kicks in.
+    RSpec::Mocks.with_temporary_scope do
+      Aws::SharedCredentials.new
+      Aws::EC2::Client.new
+      Aws::EC2::Resource.new
+    end
+  end
+  include FakeFS::SpecHelpers
+
+  before :each do
+    FakeFS.activate!
+    FakeFS::FileSystem.clone(__dir__)
+    FakeFS do
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/config.yml'), 'w') do |f|
+        f.puts('loglevel: ERROR')
+        f.puts('upload_path: /drop')
+      end
+
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/ec2_conf.json'), 'w') do |f|
+        f.puts <<-FILE
+          {
+              "dry_run": false,
+              "image_id": "ami-ea26ce85",
+              "key_name": "minecraft_keys",
+              "min_count": 1,
+              "max_count": 1,
+              "instance_type": "t2.nano",
+              "monitoring": {
+                  "enabled": true
+              }
+          }
+        FILE
+      end
+
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/instances.sql'), 'w') do |f|
+        f.puts <<-FILE
+          create table instances (
+                ip varchar(100),
+                id varchar(100),
+                PRIMARY KEY (id)
+          );
+        FILE
+      end
+
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/sg_config.json'), 'w') do |f|
+        f.puts <<-FILE
+          {
+            "ip_permissions": [
+              {
+                "ip_protocol": "tcp",
+                "from_port": 22,
+                "to_port": 22,
+                "ip_ranges": [{
+                  "cidr_ip": "0.0.0.0/0"
+                }]
+              },
+              {
+                "ip_protocol": "tcp",
+                "from_port": 25565,
+                "to_port": 25565,
+                "ip_ranges": [{
+                  "cidr_ip": "0.0.0.0/0"
+                }]
+              }
+            ]
+          }
+        FILE
+      end
+
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/user_data.sh'), 'w') do |f|
+        f.puts <<-FILE
+          !#/bin/bash
+        FILE
+      end
+
+      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      File.open(File.join(__dir__, '../cfg/minecraft.key'), 'w') do |f|
+        f.puts <<-FILE
+          somekey
+        FILE
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: aws_minecraft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gergely Brautigam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: code_stats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provisions an EC2. Uploads a world, and deploys it.
+email: skarlso777@gmail.com
+executables:
+- aws_minecraft.rb
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- "./cfg/minecraft.key"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- ROADMAP.md
+- Rakefile
+- aws_minecraft.gemspec
+- bin/aws_minecraft.rb
+- cfg/config.yml
+- cfg/ec2_conf.json
+- cfg/instances.sql
+- cfg/sg_config.json
+- cfg/user_data.sh
+- img/attach-detach.png
+- img/attach_no_session.png
+- img/attached_session.png
+- img/create.png
+- img/create_in_progress.png
+- img/stop_server.png
+- img/terminate.png
+- img/upload.png
+- lib/aws_minecraft.rb
+- lib/aws_minecraft/aws_helper.rb
+- lib/aws_minecraft/db_helper.rb
+- lib/aws_minecraft/mine_config.rb
+- lib/aws_minecraft/ssh_helper.rb
+- lib/aws_minecraft/upload_helper.rb
+- lib/aws_minecraft/version.rb
+- spec/aws_helper_spec.rb
+- spec/awsmine_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- spec/ssh_helper_spec.rb
+- spec/upload_helper_spec.rb
+homepage: https://github.com/Skarlso/aws_minecraft
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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: aws_minecraft
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A minecraft server provisioner on an AWS EC2 instance.
+test_files: []