cuboid 0.0.0 → 0.0.1alpha

data/spec/cuboid/application/runtime_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Cuboid::Application::Runtime do
+    include_examples 'application'
+
+    describe '#state' do
+        it 'provides access to the application runtime state'
+    end
+
+    describe '#state=' do
+        it 'sets the application runtime state'
+    end
+
+    describe '#data' do
+        it 'provides access to the application runtime data'
+    end
+
+    describe '#data=' do
+        it 'sets the application runtime data'
+    end
+end

data/spec/cuboid/application_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Cuboid::Application do
+    include_examples 'application'
+
+    describe '#version' do
+        it "returns #{Cuboid::VERSION}" do
+            expect(subject.version).to eq(Cuboid::VERSION)
+        end
+    end
+
+    describe '#run' do
+        context 'on invalid options' do
+            it 'raises ArgumentError'
+        end
+    end
+
+    describe '#statistics' do
+        let(:statistics) { subject.statistics }
+
+        describe ':runtime' do
+            context 'when the app has been running' do
+                it 'returns the runtime in seconds' do
+                    subject.run
+                    expect(statistics[:runtime]).to be > 0
+                end
+            end
+
+            context 'when no scan has been running' do
+                it 'returns 0' do
+                    expect(statistics[:runtime]).to eq(0)
+                end
+            end
+        end
+    end
+
+end

data/spec/cuboid/data/application_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Cuboid::Data::Application do
+
+    subject { described_class.new }
+    let(:dump_directory) do
+        "#{Dir.tmpdir}/framework-#{Cuboid::Utilities.generate_token}"
+    end
+
+    describe '#statistics' do
+        let(:statistics) { subject.statistics }
+    end
+
+    describe '#dump' do
+    end
+
+    describe '.load' do
+    end
+
+    describe '#clear' do
+    end
+end

data/spec/cuboid/data_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Cuboid::Data do
+
+    subject { described_class }
+    let(:dump_directory) do
+        "#{Dir.tmpdir}/data-#{Cuboid::Utilities.generate_token}/"
+    end
+
+    describe '#application' do
+        it "returns an instance of #{described_class::Application}" do
+            expect(subject.application).to be_kind_of described_class::Application
+        end
+    end
+
+    describe '#statistics' do
+        %w(application).each do |name|
+            it "includes :#{name} statistics" do
+                expect(subject.statistics[name.to_sym]).to eq(subject.send(name).statistics)
+            end
+        end
+    end
+
+    describe '.dump' do
+        %w(application).each do |name|
+            it "stores ##{name} to disk" do
+                previous_instance = subject.send(name)
+
+                subject.dump( dump_directory )
+
+                new_instance = subject.load( dump_directory ).send(name)
+
+                expect(new_instance).to be_kind_of subject.send(name).class
+                expect(new_instance.object_id).not_to eq(previous_instance.object_id)
+            end
+        end
+    end
+
+    describe '#clear' do
+        %w(application).each do |method|
+            it "clears ##{method}" do
+                expect(subject.send(method)).to receive(:clear).at_least(:once)
+                subject.clear
+            end
+        end
+    end
+end

data/spec/cuboid/error_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Cuboid::Error do
+    it 'inherits from StandardError' do
+        expect(Cuboid::Error <= StandardError).to be_truthy
+
+        caught = false
+        begin
+            fail Cuboid::Error
+        rescue StandardError => e
+            caught = true
+        end
+        expect(caught).to be_truthy
+
+        caught = false
+        begin
+            fail Cuboid::Error
+        rescue
+            caught = true
+        end
+        expect(caught).to be_truthy
+    end
+end

data/spec/cuboid/option_groups/datastore_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Cuboid::OptionGroups::Datastore do
+    include_examples 'option_group'
+    subject { described_class.new }
+
+    it 'creates attribute accessors on the fly' do
+        subject.test = 1
+        expect(subject.test).to eq(1)
+    end
+
+    describe '#to_h' do
+        it 'only includes attributes with accessors' do
+            method = :stuff=
+
+            subject.instance_variable_set( :@blah, true )
+
+            value = subject.send( method, 'stuff' )
+            expect(subject.to_h).to eq({ method.to_s[0...-1].to_sym => value })
+        end
+    end
+
+    describe '#update' do
+        it 'updates self with the values of the given hash' do
+            method = :stuff
+            value  = 'stuff'
+
+            subject.update( { method => value } )
+            expect(subject.send( method )).to include value
+        end
+
+        it 'returns self' do
+            expect(subject.update({})).to eq(subject)
+        end
+    end
+
+    describe '#merge' do
+        it 'updates self with the values of the given OptionGroup' do
+            method = :stuff
+            value  = 'stuff'
+
+            group = described_class.new
+            group.update( { method => value } )
+
+            subject.merge( group )
+            expect(subject.send( method )).to include value
+        end
+
+        it 'returns self' do
+            group = described_class.new
+            expect(subject.merge( group )).to eq(subject)
+        end
+    end
+end

data/spec/cuboid/option_groups/dispatcher_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Cuboid::OptionGroups::Dispatcher do
+    include_examples 'option_group'
+    subject { described_class.new }
+
+    %w(url instance_port_range neighbour ping_interval name).each do |method|
+        it { is_expected.to respond_to method }
+        it { is_expected.to respond_to "#{method}=" }
+    end
+
+end

data/spec/cuboid/option_groups/output_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Cuboid::OptionGroups::Output do
+    include_examples 'option_group'
+    subject { described_class.new }
+
+    %w(reroute_to_logfile).each do |method|
+        it { is_expected.to respond_to method }
+        it { is_expected.to respond_to "#{method}=" }
+    end
+end

data/spec/cuboid/option_groups/paths_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Cuboid::OptionGroups::Paths do
+
+    before :all do
+        @created_resources = []
+    end
+
+    after :each do
+        ENV['CUBOID_LOGDIR'] = nil
+
+        (@created_resources + [paths_config_file]).each do |r|
+            FileUtils.rm_rf r
+        end
+    end
+
+    let(:paths_config_file) { "#{Cuboid::Options.paths.tmpdir}/paths-#{Process.pid}.yml" }
+
+    %w(root logs reports lib support mixins snapshots).each do |method|
+
+        describe "##{method}" do
+            it 'points to an existing directory' do
+                expect(File.exists?( subject.send method )).to be_truthy
+            end
+        end
+
+        describe "##{method}=" do
+            context 'when the path is missing a slash in the end' do
+                it 'raises error' do
+                    dir = subject.tmpdir[0..-1]
+                    subject.send "#{method}=", dir
+
+                    expect(dir).to_not end_with '/'
+                    expect(subject.send(method)).to end_with '/'
+                end
+            end
+
+            context 'when given an invalid directory' do
+                it 'raises error' do
+                    expect do
+                        subject.send "#{method}=", 'flflflfl'
+                    end.to raise_error ArgumentError
+                end
+            end
+        end
+
+        it { is_expected.to respond_to method }
+        it { is_expected.to respond_to "#{method}=" }
+    end
+
+    describe '#tmpdir' do
+        context 'when no tmpdir has been specified via config' do
+            it 'defaults to the OS tmpdir' do
+                expect(subject.tmpdir).to eq Cuboid.get_long_win32_filename( "#{Dir.tmpdir}/Cuboid_#{Process.pid}" )
+            end
+        end
+
+        context "when #{described_class}.config['tmpdir']" do
+            it 'returns its value' do
+                allow(described_class).to receive(:config) do
+                    {
+                        'tmpdir' => "#{Dir.tmpdir}/my/tmpdir"
+                    }
+                end
+
+                expect(subject.tmpdir).to eq("#{Dir.tmpdir}/my/tmpdir/Cuboid_#{Process.pid}")
+            end
+        end
+    end
+
+    describe '#logs' do
+        it 'returns the default location' do
+            expect(subject.logs).to eq("#{subject.root}logs/")
+        end
+
+        context 'when the CUBOID_LOGDIR environment variable' do
+            after { ENV['CUBOID_LOGDIR'] = '' }
+
+            it 'returns its value' do
+                ENV['CUBOID_LOGDIR'] = 'test'
+                expect(subject.logs).to eq('test/')
+            end
+        end
+
+        context "when #{described_class}.config['logs']" do
+            it 'returns its value' do
+                allow(described_class).to receive(:config) do
+                    {
+                        'logs' => 'logs-stuff/'
+                    }
+                end
+
+                expect(described_class.new.logs).to eq('logs-stuff/')
+            end
+        end
+    end
+
+    describe '#snapshots' do
+        it 'returns the default location' do
+            expect(subject.snapshots).to eq("#{subject.root}snapshots/")
+        end
+
+        context "when #{described_class}.config['snapshots']" do
+            it 'returns its value' do
+                allow(described_class).to receive(:config) do
+                    {
+                        'snapshots' => 'snapshots-stuff/'
+                    }
+                end
+
+                expect(described_class.new.snapshots).to eq('snapshots-stuff/')
+            end
+        end
+    end
+
+    describe '#reports' do
+        it 'returns the default location' do
+            expect(subject.reports).to eq("#{subject.root}reports/")
+        end
+
+        context "when #{described_class}.config['reports']" do
+            it 'returns its value' do
+                allow(described_class).to receive(:config) do
+                    {
+                        'reports' => 'reports-stuff/'
+                    }
+                end
+
+                expect(described_class.new.reports).to eq('reports-stuff/')
+            end
+        end
+    end
+
+    describe '.config' do
+        let(:config) { described_class.config }
+
+        it 'expands ~ to $HOME', if: !Cuboid.windows? do
+            yaml = {
+                'blah' => "~/foo-#{Process.pid}/"
+            }.to_yaml
+
+            allow(described_class).to receive(:paths_config_file) { paths_config_file }
+            IO.write( described_class.paths_config_file, yaml )
+            described_class.clear_config_cache
+
+            @created_resources << described_class.config['blah']
+
+            expect(described_class.config['blah']).to eq("#{ENV['HOME']}/foo-#{Process.pid}/")
+        end
+
+        it 'appends / to paths' do
+            dir = "#{Dir.tmpdir}/foo-#{Process.pid}"
+            yaml = {
+                'blah' => dir
+            }.to_yaml
+
+            allow(described_class).to receive(:paths_config_file) { paths_config_file }
+            IO.write( described_class.paths_config_file, yaml )
+            described_class.clear_config_cache
+
+            @created_resources << described_class.config['blah']
+
+            expect(described_class.config['blah']).to eq("#{dir}/")
+        end
+
+        it 'creates the given directories' do
+            dir = "#{Dir.tmpdir}/foo/stuff-#{Process.pid}"
+            yaml = {
+                'blah' => dir
+            }.to_yaml
+
+            allow(described_class).to receive(:paths_config_file) { paths_config_file }
+            IO.write( described_class.paths_config_file, yaml )
+            described_class.clear_config_cache
+
+            @created_resources << dir
+
+            expect(File.exist?( dir )).to be_falsey
+            described_class.config
+            expect(File.exist?( dir )).to be_truthy
+        end
+    end
+
+end

data/spec/cuboid/option_groups/report_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Cuboid::OptionGroups::Report do
+    include_examples 'option_group'
+    subject { described_class.new }
+
+    %w(path).each do |method|
+        it { is_expected.to respond_to method }
+        it { is_expected.to respond_to "#{method}=" }
+    end
+
+    describe '#path' do
+        context "when #{Cuboid::OptionGroups::Paths}.config['reports']" do
+            it 'returns it' do
+                allow(Cuboid::OptionGroups::Paths).to receive(:config) do
+                    {
+                        'reports' => Dir.tmpdir
+                    }
+                end
+
+                expect(subject.path).to eq(Dir.tmpdir + '/')
+            end
+        end
+    end
+
+end