nucleus 0.1.0

data/spec/integration/api/swagger_schema_spec.rb

@@ -0,0 +1,64 @@
+require 'spec/integration/integration_spec_helper'
+
+describe 'Swagger schema' do
+  context 'with an invalid version can not access' do
+    let!(:header) { { 'HTTP_ACCEPT' => 'application/vnd.nucleus-invalidversion' } }
+
+    context 'GET apis' do
+      before { get '/schema', header }
+      include_examples 'a not accepted request'
+    end
+    context 'GET endpoints schema' do
+      before { get '/schema/endpoints', header }
+      include_examples 'a not accepted request'
+    end
+    context 'GET vendors schema' do
+      before { get '/schema/vendors', header }
+      include_examples 'a not accepted request'
+    end
+    context 'GET providers schema' do
+      before { get '/schema/providers', header }
+      include_examples 'a not accepted request'
+    end
+  end
+
+  describe 'with a version can access' do
+    let!(:header) { { 'HTTP_ACCEPT' => 'application/vnd.nucleus-v1' } }
+
+    context 'GET apis schema' do
+      before { get '/schema', header }
+      include_examples 'a valid GET request'
+    end
+    context 'GET endpoints schema' do
+      before { get '/schema/endpoints', header }
+      include_examples 'a valid GET request'
+    end
+    context 'GET vendors schema' do
+      before { get '/schema/vendors', header }
+      include_examples 'a valid GET request'
+    end
+    context 'GET providers schema' do
+      before { get '/schema/providers', header }
+      include_examples 'a valid GET request'
+    end
+  end
+
+  describe 'without a version can access' do
+    context 'GET apis schema' do
+      before { get '/schema' }
+      include_examples 'a valid GET request'
+    end
+    context 'GET endpoints schema' do
+      before { get '/schema/endpoints' }
+      include_examples 'a valid GET request'
+    end
+    context 'GET vendors schema' do
+      before { get '/schema/vendors' }
+      include_examples 'a valid GET request'
+    end
+    context 'GET providers schema' do
+      before { get '/schema/providers' }
+      include_examples 'a valid GET request'
+    end
+  end
+end

data/spec/integration/api/vendors_spec.rb

@@ -0,0 +1,45 @@
+require 'spec/integration/integration_spec_helper'
+
+describe Nucleus::API::V1::Vendors do
+  after { Nucleus::TestDataGenerator.clean }
+
+  let!(:vendor_a) { create(:vendor) }
+  let!(:vendor_b) { create(:vendor) }
+  let!(:provider_a) { create(:provider, vendor: vendor_a.id) }
+  let!(:provider_b) { create(:provider, vendor: vendor_a.id) }
+  let!(:provider_c) { create(:provider, vendor: vendor_b.id) }
+  let!(:endpoint_a) { create(:endpoint, provider: provider_a.id) }
+  let!(:endpoint_b) { create(:endpoint, provider: provider_b.id) }
+
+  context 'GET /vendors response' do
+    before { get '/vendors' }
+    include_examples 'a valid GET request'
+    it 'has vendor-list like structure' do
+      expect_json_types(size: :int, vendors: :array_of_objects, _links: :object)
+    end
+
+    # TODO: contains all required fields
+
+    it 'shows the retrieved number of vendors' do
+      expect(json_body[:size]).to eq 2
+      expect_json_sizes(vendors: 2)
+    end
+    it 'lists all vendors' do
+      expect(json_body[:vendors]).to_not be_nil
+      expect(json_body[:vendors][0][:id]).to eq vendor_a.id
+      expect(json_body[:vendors][1][:id]).to eq vendor_b.id
+    end
+  end
+
+  context 'GET /vendors/:id' do
+    before { get "/vendors/#{vendor_a.id}" }
+    include_examples 'a valid GET request'
+    it 'has the structure of an vendor object' do
+      expect_json_types(id: :string, name: :string, created_at: :date, updated_at: :date,
+                        providers: :array_of_objects, _links: :object)
+    end
+    it 'contains the requested vendor' do
+      expect(json_body[:id]).to eq vendor_a.id
+    end
+  end
+end

data/spec/integration/integration_spec_helper.rb

@@ -0,0 +1,27 @@
+require 'spec/spec_helper'
+require 'nucleus_api/scripts/rack_application'
+require 'spec/integration/test_data_generator'
+require 'spec/support/shared_example_request_types'
+require 'airborne'
+
+# define test suite for coverage report
+SimpleCov.command_name 'spec:suite:integration'
+
+Airborne.configure do |config|
+  config.rack_app = Nucleus::API::Rack.app
+  config.headers = { 'HTTP_ACCEPT' => 'application/vnd.nucleus-v1' }
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Nucleus::TestDataGenerator.clean
+  end
+
+  config.after(:suite) do
+    Nucleus::TestDataGenerator.clean
+  end
+
+  config.after(:each) do
+    Excon.stubs.clear
+  end
+end

data/spec/integration/test_data_generator.rb

@@ -0,0 +1,55 @@
+module Nucleus
+  module TestDataGenerator
+    def self.clean
+      nucleus_config.api.versions.each do |api_version|
+        Nucleus::API::DB::AdapterDao.instance(api_version).clear
+        Nucleus::API::DB::EndpointDao.instance(api_version).clear
+        Nucleus::API::DB::ProviderDao.instance(api_version).clear
+        Nucleus::API::DB::VendorDao.instance(api_version).clear
+        Nucleus::API::DB::CacheDao.instance(api_version).clear
+      end
+    end
+  end
+
+  module DaoResolver
+    def self.resolve(entity)
+      # TODO: find a solution how to test when multiple API versions are supported
+      version = 'v1'
+      case entity
+      when Nucleus::Endpoint
+        dao = Nucleus::API::DB::EndpointDao.instance(version)
+      when Nucleus::Provider
+        dao = Nucleus::API::DB::ProviderDao.instance(version)
+      when Nucleus::Vendor
+        dao = Nucleus::API::DB::VendorDao.instance(version)
+      when Nucleus::AdapterIndexEntry
+        dao = Nucleus::API::DB::AdapterDao.instance(version)
+      end
+      dao
+    end
+  end
+
+  class AbstractModel
+    def save!
+      dao = DaoResolver.resolve self
+      dao.set self
+    end
+
+    def new_record?
+      dao = DaoResolver.resolve self
+      dao.key? id
+    end
+  end
+
+  class AdapterIndexEntry
+    def save!
+      dao = DaoResolver.resolve self
+      dao.set self
+    end
+
+    def new_record?
+      dao = DaoResolver.resolve self
+      dao.key? id
+    end
+  end
+end

data/spec/nucleus_git_key.pem

@@ -0,0 +1,51 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIJKAIBAAKCAgEAwh4DXOI0Um7OjUcAHuAfrlnZm1VTnzqWkKsqtF5M9vBVK/sI
+OPX94mlClkp8SQ/qzA3Yik46zNzcl81vFhQyE+nP4NVpNf0DoCC9aJctuiEeKdEw
+SUSa02Y95q37X3k45Z/AAe9SHMbqbCwRiMuqHlrqBCu+1r7h7gSsbGnKZnzwl4Xg
+SintUN+eI4KEfj/a9eogDhcxjc37M/eQ9nbIUwdT4KvK/Six9B1Fo3potAanjIxy
+rSU6VQsPMDwWJWC7QZYPLaPysogQtL4zV05Lz2QC1vhYRzs4F/EMo1ZQO2OUaR6p
+lnNparN+ChMa+spKMWOeHS9sr2Fh+dMRfHacmRee7nVnaZJ0RjUmXzis9MEWdqKk
+eqf065I1VxUoxDctCxe54vGOr9gV2dmD4Ska/GgzGmVbc4Wx+8ni0g6D586baSV1
+xcgfRWSaHQ6KTEO7wdbCDNF/0UoDm3W8Uid8HatlfHKjQvyz1wsnFebjESFD/4Pl
+9X40U1QJwUiw2M18eVsjRZQ4E4SBMkelCwrbJDKCMTi5TzwJeoH32dNwo5Nijd/h
+BGcinOiozaGctvv32B3a4Q3ndCyBe29ttxNvJyjslq7KAFdSHFA6rCHveVVLaBku
+lgmfuXDhX5MTE7sZ9P0HfqAgRe7Q9rHOFG6N5hmytHvsmKhPGz1iP5Ij4VsCAwEA
+AQKCAgEAhZMzizHZATRgi9Tkn1poUohfdkUT4sjlHK28GBuf6HjekwIN2WxkhO0b
+teGRfpEmZ73LWPiV+6yrWwYxP8cr4ooM0tDnsg/l88UzsQn+nEr3v5zEFlbQF1IO
+nHLyO/NllJUGAg7VuRmj7EWy1ygWawbya2ZSzuDRBQFQSNXPQhENWab0/PO26uTF
+o/fHBj0YhgnSfv+0yLiJ+GuN5Bs+o+ux6zMr3mKneay+48xyyhaeKtfmfYDVj/mp
+PO7L6nKSyIHi9ewQMIvyuvz6xUQKZK6USargzDtS0R69LJRTZ1qRoHhKCE5optTW
+kUYuVY7n2O6MudaNem2PhuKX8MaJ4Jf1rxoSdZTozj4T3OepHo994tL2umN1xcdL
+xK6UkgdNZqmjkZtroAxy180zDkh+K/Lx2MIIWr3oWE9p1aSFf4XfoUW2uIwfzido
+w4vxOnE8bmXAL2CNVOIqtg0Jfd/EZPcDBhEKRTyPRUkHZbTb6ARfyQp3uZl3sQHB
+8A/2IAT94YirJC71upgTmanq3CXSA6Cy4OT/1gB1y7jxrSJeLe04EbMn6svU/Y8b
+jSBj+ztozqCGzAZS1+QaC0QQp1czuTQil62BtldJdJ1aeemoTuzhtlgqcCKnNbop
+8tUZcKSAzFIWRzhk/R2K/yNs9jBCxppkp2coj3FRH3f0T58Zg+ECggEBAOVf+aJZ
+Tv2mlLvBJXcW0yS0m+nBvnDnw882HkfDRTJGd1n1UQnHAETpxpa3rr5iPLp4L+47
+DxVCF1r/PpiOqvxyvACdV8bP4Mg8+yXgHqvSqq1VCEupbmc7ICrmYWsb4gm1iCJC
+XnyMs5ln4WbzZUVRZ/pQiHMGuPrms3gM4YZvkL9MqmNxVQemVsBLTxgbZyi0dDAw
+OprWqi9BsAfY8dm3Z3ILQfOQQcaTWfy/Px6tZufnodZMKUFcmWaMTHTed5HD3OiL
+0o21ujYdKAc2TrE5B2ZLcyZYSvt5iPerjNAU4FLbm7wQ0V2ofhrbxDLrJn+tuwyx
+g0ley+x9yXHQD7ECggEBANimVWFHyryveb9GP4sc97JZLb0JsSxCWB1ziV/wFR81
+pEhm2NXRWbttCZT9nu28ec3WpHBXoKCUjQf2+n7kZ/M1HmWZWt1EXgwgTrAdf0LB
+eaaU1T5TGwRBRhv0b5RE0mgnjigVbPOFtOmbBJZcdw8cx0m6dcX0lAiAGdsSt6/g
+RSbvZxV+rngkZmknR5toNpgWCd+KS54j0hh+yAmS+x9DfT2l59nFCmS/8WenNQ29
+pN3Lh6rqzebkg2d+ZunR+ITr0PaD0iY7d14qnzWrS5HxT1iPxGqbxHDVAv+J/Fth
+iZCPht5WTYDB8mQj0loXV4wyALIs/w0LSswDvIxqcMsCggEAIKPttCqdUP8ZfzZX
+DIFU/o4s+bC2Vv7EIIKFAJVLDYJ1jXmZVJja8vOJbP0qgrEcDzT3LSF+XfoPtMVJ
+tQ/oSRBSrIu3Z/VA+X2kB5nDA5Rw8UV+brXnng0N4Mzz4/gNzG/mtWlYZMTo8dWU
+f7/3E0woTbiUEjpMrHeT5mt+1FCf+nkAbjI8dWA4TBjrYnTT0zkKp6jVTh9qDFt+
+nz9B+0dcEyCC/BP1KDrjvVHBu63VTP7rSsF/xWtV8P/aCW92+Gk00GrFRaEspHK1
+tYEG5bVF1kq6UiSSVwLOeOASo7G00lWp7bM+9+L4Pv4zB0PrMJQaYA4KrrAsuLSV
+q/p9oQKCAQB1FxC2DvMHn18RfYoCSZmljoUl0gMrhH/TCwqIC12fDILJjqxKg2cX
+4Qp4t8oZeu/py8P746AwqZi/YUBpLFDyJRdUmdl+FOEvdJaSoJ6TGbYBzhaiJJBJ
+cG3P1gAoBjohiJ9QEqRbyTvJtbp4+WhvhoI+2sOkRVdscK+Is0kLiQ5WyLTR7TGm
+RSYEVvJgj6ZR9DdJ1Zig04NNMdgzNHj8oKEjnHL+Q3wmj4aNGtWVo5VjOgkM2vKF
+g6NxX+OHI7BJRpodYYlGmIUfI7IAc5/YNK9Jkgn6BE3bHYUNTypQyRpsQuYFbGde
+23OBo8qgXlU2tB+kLKV8C0pVkP9qdGyZAoIBADdodqIk+C9ZUaKiTozhZnbvo8rK
+/PL+ze/qf/81hC8LuHfhOlJ6Q35aYim54clk03TL1Y76Hx0fiVApketlV0/hgYa6
+Ea39j+Z+2515HoeInycn0sBtsiX0giSJzGuXNbUT+LrNi2sAyUmQ+INGlPdkHp/S
+V2GylNssnbwwYT3VLchO4PLdYhdkE6BYkv0PflGQxSu86K+lrLNTWtJF0DwTbyGM
+MC1TY2r+u2iJsijkB9ukoIDxljerUCaokQlrnFTVrRgxk7KaceV2PE4nTHwjALbF
++J2h+TT61CQCdGbGqU6UPiXaLqMKLgt89xfyybsl4WpM/oHaKRPUk96ZIu0=
+-----END RSA PRIVATE KEY-----

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+$LOAD_PATH << File.join(__dir__, '..')
+
+# figure out where we are being loaded from
+if $LOADED_FEATURES.grep(%r{spec\/spec_helper\.rb}).any?
+  begin
+    fail 'foo'
+  rescue => e
+    puts <<-MSG
+  ===================================================
+  It looks like spec_helper.rb has been loaded
+  multiple times. Normalize the require to:
+
+    require "spec/spec_helper"
+
+  Things like File.join and File.expand_path will
+  cause it to be loaded multiple times.
+
+  Loaded this time from:
+
+    #{e.backtrace.join("\n    ")}
+  ===================================================
+    MSG
+  end
+end
+
+require 'vcr'
+require 'factory_girl'
+require 'faker'
+require 'tmpdir'
+
+# we need this to detect whether to apply test middleware (tailing hack)
+ENV['RACK_ENV'] = 'test'
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'simplecov'
+  require 'codeclimate-test-reporter'
+  SimpleCov.add_filter 'vendor'
+  SimpleCov.formatters = []
+  # merge results of the last 1 hour
+  SimpleCov.merge_timeout 3600
+  SimpleCov.start CodeClimate::TestReporter.configuration.profile
+else
+  require 'simplecov'
+  # merge results of the last 1 hour
+  SimpleCov.merge_timeout 3600
+  SimpleCov.start do
+    add_filter 'spec/'
+    add_filter 'lib/nucleus/scripts/'
+    add_filter 'config/'
+
+    add_group 'Adapters', 'lib/nucleus/adapters'
+    add_group 'Core', 'lib/nucleus/core'
+    add_group 'Persistence', 'lib/nucleus/persistence'
+    add_group 'Lib ext.', 'lib/nucleus/ext'
+    add_group 'API versions', 'lib/nucleus_api/api/versions'
+    add_group 'API entities', 'lib/nucleus_api/api/entities'
+    add_group 'API helpers', 'lib/nucleus_api/api/helpers'
+    add_group 'API Middleware', 'lib/nucleus_api/rack_middleware'
+    add_group 'API Models', 'lib/nucleus_api/models'
+    add_group 'API Lib ext.', 'lib/nucleus_api/ext'
+  end
+end
+
+# load configuration for integration tests
+require 'nucleus/scripts/setup_config'
+# disable logging
+# TODO: disable logging via proper config option
+nucleus_config.logging.level = Logger::Severity::FATAL
+# force tmp database
+nucleus_config.db.path = File.join(Dir.tmpdir, "#{SecureRandom.uuid}.nucleus.test.store")
+nucleus_config.db.delete_on_shutdown = true
+nucleus_config.db.override = true
+
+# require our app
+require 'nucleus_api/scripts/load_api'
+
+# load the certificate to use for the tests only
+nucleus_config.ssh.custom_key = File.expand_path(File.join('spec', 'nucleus_git_key.pem'))
+
+# initialize db, versions and auth strategy
+require 'nucleus/scripts/initialize_config_defaults'
+# initialize the api config
+require 'nucleus_api/scripts/initialize_api_customizations'
+
+require 'spec/factories/models'
+
+# require shared examples
+require_all 'spec/support'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.before(:suite) do
+    Excon.defaults[:mock] = true
+  end
+  config.after(:each) do
+    Excon.stubs.clear
+  end
+end

data/spec/support/shared_example_request_types.rb

@@ -0,0 +1,99 @@
+shared_examples 'contains the request ID' do
+  it 'has a request id' do
+    expect(headers['X-Request-ID']).to_not be_nil
+  end
+end
+
+shared_examples 'valid error' do
+  include_examples 'contains the request ID'
+  include_examples 'valid error schema'
+end
+
+shared_examples 'valid error schema' do
+  it 'complies with the error schema' do
+    expect_json_keys(:status, :dev_message, :message, :error_code, :more_info)
+  end
+  it 'status matches error schema status' do
+    expect(json_body[:status]).to eq(response.status)
+  end
+  it 'has a not nil developer message' do
+    expect(json_body[:dev_message]).to_not be_nil
+  end
+  it 'has a non empty developer message' do
+    expect(json_body[:dev_message].strip.length).to be > 0
+  end
+end
+
+shared_examples 'an unknown requested resource' do
+  include_examples 'contains the request ID'
+  it 'has status 404' do
+    expect_status 404
+  end
+end
+
+shared_examples 'an unauthorized request' do
+  include_examples 'contains the request ID'
+  it 'has status 401' do
+    expect_status 401
+  end
+end
+
+shared_examples 'a bad request' do
+  include_examples 'valid error'
+  it 'has status 400' do
+    expect_status 400
+  end
+  it 'has a developer message' do
+    expect(json_body[:dev_message]).to_not be_nil
+    expect(json_body[:dev_message].strip.length).to be > 0
+  end
+end
+
+shared_examples 'a semantically invalid request' do
+  include_examples 'valid error'
+  it 'has status 422' do
+    expect_status 422
+  end
+end
+
+shared_examples 'a not accepted request' do
+  include_examples 'valid error'
+  it 'has status 406' do
+    expect_status 406
+  end
+end
+
+shared_examples 'a valid GET request' do
+  include_examples 'contains the request ID'
+  it 'has status 200' do
+    expect_status 200
+  end
+end
+
+shared_examples 'a valid POST request' do
+  include_examples 'contains the request ID'
+  it 'has status 201' do
+    expect_status 201
+  end
+end
+
+shared_examples 'a valid POST action request' do
+  include_examples 'contains the request ID'
+  it 'has status 200' do
+    expect_status 200
+  end
+end
+
+shared_examples 'a valid PATCH request' do
+  include_examples 'contains the request ID'
+  it 'has status 200' do
+    expect_status 200
+  end
+end
+
+shared_examples 'a valid DELETE request' do
+  include_examples 'contains the request ID'
+  it 'has status 204' do
+    expect_status 204
+  end
+end

data/spec/test_suites.rake

@@ -0,0 +1,31 @@
+require 'rspec/core/rake_task'
+
+SPEC_SUITES = [
+  { id: :unit, title: 'unit tests', pattern: 'spec/unit/**/*_spec.rb' },
+  { id: :adapters, title: 'adapter tests', pattern: 'spec/adapter/**/*_spec.rb' },
+  { id: :integration, title: 'integration tests', pattern: 'spec/integration/**/*_spec.rb' }
+]
+
+namespace :spec do
+  namespace :suite do
+    SPEC_SUITES.each do |suite|
+      desc "Run all specs in #{suite[:title]} spec suite"
+      RSpec::Core::RakeTask.new(suite[:id]) do |t|
+        t.pattern = suite[:pattern]
+        t.verbose = false
+        t.fail_on_error = false
+      end
+    end
+    desc 'Run all spec suites'
+    task :all do
+      require 'English'
+      failed = []
+      SPEC_SUITES.each do |suite|
+        p "Running spec suite #{suite[:id]} ..."
+        Rake::Task["spec:suite:#{suite[:id]}"].execute
+        failed << suite[:id] unless $CHILD_STATUS.success?
+      end
+      fail "Spec suite#{failed.length > 1 ? 's' : ''} '#{failed.join(', ')}' failed" unless failed.empty?
+    end
+  end
+end