policy_machine 0.0.1

data/spec/support/shared_examples_policy_machine_storage_adapter_spec.rb

@@ -0,0 +1,278 @@
+# Policy Machines are directed acyclic graphs (DAG).  These shared examples describe the
+# API for these DAGs, which could be persisted in memory, in a graph database, etc.
+
+require_relative 'storage_adapter_helpers.rb'
+
+shared_examples "a policy machine storage adapter" do
+  let(:policy_machine_storage_adapter) { described_class.new }
+
+  PolicyMachine::POLICY_ELEMENT_TYPES.each do |pe_type|
+    describe "#add_#{pe_type}" do
+      it 'stores the policy element' do
+        src = policy_machine_storage_adapter.send("add_#{pe_type}", 'some_uuid', 'some_policy_machine_uuid')
+        policy_machine_storage_adapter.element_in_machine?(src).should be_true
+      end
+
+      it 'returns the instantiated policy element with persisted attribute set to true' do
+        node = policy_machine_storage_adapter.send("add_#{pe_type}", 'some_uuid', 'some_policy_machine_uuid')
+        node.persisted.should be_true
+      end
+    end
+
+    describe "find_all_of_type_#{pe_type}" do
+      it 'returns empty array if nothing found' do
+        policy_machine_storage_adapter.send("find_all_of_type_#{pe_type}").should == []
+      end
+
+      it 'returns array of found policy elements of given type if one is found' do
+        node = policy_machine_storage_adapter.send("add_#{pe_type}", 'some_uuid', 'some_policy_machine_uuid')
+        policy_machine_storage_adapter.send("find_all_of_type_#{pe_type}").should == [node]
+      end
+
+      it 'returns array of found policy elements of given type if more than one is found' do
+        node1 = policy_machine_storage_adapter.send("add_#{pe_type}", 'some_uuid1', 'some_policy_machine_uuid')
+        node2 = policy_machine_storage_adapter.send("add_#{pe_type}", 'some_uuid2', 'some_policy_machine_uuid')
+        policy_machine_storage_adapter.send("find_all_of_type_#{pe_type}").should == [node1, node2]
+      end
+    end
+  end
+
+  describe '#assign' do
+    before do
+      @src = policy_machine_storage_adapter.add_user('some_uuid1', 'some_policy_machine_uuid1')
+      @dst = policy_machine_storage_adapter.add_user_attribute('some_uuid2', 'some_policy_machine_uuid1')
+    end
+
+    context 'source or destination node is of the Node type return by add_' do
+      it 'assigns the nodes in one direction (from source to destination)' do
+        policy_machine_storage_adapter.assign(@src, @dst)
+        policy_machine_storage_adapter.connected?(@src, @dst).should be_true
+      end
+
+      it 'does not connect the nodes from destination to source' do
+        policy_machine_storage_adapter.assign(@src, @dst)
+        policy_machine_storage_adapter.connected?(@dst, @src).should be_false
+      end
+
+      it 'returns true' do
+        policy_machine_storage_adapter.assign(@src, @dst).should be_true
+      end
+    end
+
+    context 'source or destination node is not of the Node type return by add_' do
+      it 'raises for source' do
+        expect{ policy_machine_storage_adapter.assign(2, @dst) }.to raise_error(ArgumentError)
+      end
+
+      it 'raises for destination' do
+        expect{ policy_machine_storage_adapter.assign(@src, "") }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#connected?' do
+    before do
+      @src = policy_machine_storage_adapter.add_user('some_uuid1', 'some_policy_machine_uuid1')
+      @dst = policy_machine_storage_adapter.add_user_attribute('some_uuid2', 'some_policy_machine_uuid1')
+
+      @internal1 = policy_machine_storage_adapter.add_user_attribute('some_uuid2a', 'some_policy_machine_uuid1')
+      @internal2 = policy_machine_storage_adapter.add_user_attribute('some_uuid2b', 'some_policy_machine_uuid1')
+      @internal3 = policy_machine_storage_adapter.add_user_attribute('some_uuid2c', 'some_policy_machine_uuid1')
+
+      policy_machine_storage_adapter.assign(@src, @internal1)
+      policy_machine_storage_adapter.assign(@internal1, @internal3)
+      policy_machine_storage_adapter.assign(@internal2, @internal1)
+      policy_machine_storage_adapter.assign(@internal3, @dst)
+    end
+
+    context 'source or destination node is of the Node type return by add_node' do
+      it 'returns true if source and destination nodes are connected' do
+        policy_machine_storage_adapter.connected?(@src, @dst).should be_true
+      end
+
+      it 'returns false if source and destination nodes are not connected' do
+        policy_machine_storage_adapter.connected?(@src, @internal2).should be_false
+      end
+    end
+
+    context 'source or destination node is not of the Node type return by add_node' do
+      it 'raises for source' do
+        expect{ policy_machine_storage_adapter.connected?("", @dst) }.to raise_error(ArgumentError)
+      end
+
+      it 'raises for destination' do
+        expect{ policy_machine_storage_adapter.connected?(@src, 6) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#unassign' do
+    before do
+      @src = policy_machine_storage_adapter.add_user('some_uuid1', 'some_policy_machine_uuid1')
+      @dst = policy_machine_storage_adapter.add_user_attribute('some_uuid2', 'some_policy_machine_uuid1')
+      policy_machine_storage_adapter.assign(@src, @dst)
+    end
+
+    context 'source or destination node is of the Node type return by add_' do
+      it 'disconnects source node from destination node' do
+        policy_machine_storage_adapter.unassign(@src, @dst)
+        policy_machine_storage_adapter.connected?(@src, @dst).should be_false
+      end
+
+      it 'does not disconnect destination from source node if there is an assignment in that direction' do
+        policy_machine_storage_adapter.assign(@dst, @src)
+        policy_machine_storage_adapter.unassign(@src, @dst)
+        policy_machine_storage_adapter.connected?(@dst, @src).should be_true
+      end
+
+      it 'returns true on successful disconnection' do
+        policy_machine_storage_adapter.unassign(@src, @dst).should be_true
+      end
+
+      it "returns false on unsuccessful disconnection (if the nodes weren't connected in the first place')" do
+        policy_machine_storage_adapter.unassign(@src, @dst)
+        policy_machine_storage_adapter.unassign(@src, @dst).should be_false
+      end
+    end
+
+    context 'source or destination node is not of the Node type return by add_node' do
+      it 'raises for source' do
+        expect{ policy_machine_storage_adapter.unassign(6, @dst) }.to raise_error(ArgumentError)
+      end
+
+      it 'raises for destination' do
+        expect{ policy_machine_storage_adapter.unassign(false, @dst) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#element_in_machine?' do
+    before do
+      @pe = policy_machine_storage_adapter.add_user('some_uuid1', 'some_policy_machine_uuid1')
+    end
+
+    it 'returns true when element is in machine' do
+      policy_machine_storage_adapter.element_in_machine?(@pe).should be_true
+    end
+  end
+
+  describe '#add_association' do
+    before do
+      @ua = policy_machine_storage_adapter.add_user_attribute('some_ua', 'some_policy_machine_uuid1')
+      @r = policy_machine_storage_adapter.add_operation('read', 'some_policy_machine_uuid1')
+      @w = policy_machine_storage_adapter.add_operation('write', 'some_policy_machine_uuid1')
+      @oa = policy_machine_storage_adapter.add_object_attribute('some_oa', 'some_policy_machine_uuid1')
+    end
+
+    it 'returns true' do
+      policy_machine_storage_adapter.add_association(@ua, Set.new([@r, @w]), @oa, 'some_policy_machine_uuid1').should be_true
+    end
+
+    it 'stores the association' do
+      policy_machine_storage_adapter.add_association(@ua, Set.new([@r, @w]), @oa, 'some_policy_machine_uuid1')
+      assocs_with_r = policy_machine_storage_adapter.associations_with(@r)
+      assocs_with_r.size == 1
+      assocs_with_r[0][0].should == @ua
+      assocs_with_r[0][1].to_a.should == [@r, @w]
+      assocs_with_r[0][2].should == @oa
+
+      assocs_with_w = policy_machine_storage_adapter.associations_with(@w)
+      assocs_with_w.size == 1
+      assocs_with_w[0][0].should == @ua
+      assocs_with_w[0][1].to_a.should == [@r, @w]
+      assocs_with_w[0][2].should == @oa
+    end
+
+    it 'overwrites a previously stored association' do
+      policy_machine_storage_adapter.add_association(@ua, Set.new([@r, @w]), @oa, 'some_policy_machine_uuid1')
+      policy_machine_storage_adapter.add_association(@ua, Set.new([@r]), @oa, 'some_policy_machine_uuid1')
+      assocs_with_r = policy_machine_storage_adapter.associations_with(@r)
+      assocs_with_r.size == 1
+      assocs_with_r[0][0].should == @ua
+      assocs_with_r[0][1].to_a.should == [@r]
+      assocs_with_r[0][2].should == @oa
+
+      policy_machine_storage_adapter.associations_with(@w).should == []
+    end
+  end
+
+  describe '#associations_with' do
+    before do
+      @ua = policy_machine_storage_adapter.add_user_attribute('some_ua', 'some_policy_machine_uuid1')
+      @ua2 = policy_machine_storage_adapter.add_user_attribute('some_other_ua', 'some_policy_machine_uuid1')
+      @r = policy_machine_storage_adapter.add_operation('read', 'some_policy_machine_uuid1')
+      @w = policy_machine_storage_adapter.add_operation('write', 'some_policy_machine_uuid1')
+      @e = policy_machine_storage_adapter.add_operation('execute', 'some_policy_machine_uuid1')
+      @oa = policy_machine_storage_adapter.add_object_attribute('some_oa', 'some_policy_machine_uuid1')
+    end
+
+    it 'returns empty array when given operation has no associated associations' do
+      policy_machine_storage_adapter.associations_with(@r).should == []
+    end
+
+    it 'returns structured array when given operation has associated associations' do
+      policy_machine_storage_adapter.add_association(@ua, Set.new([@w]), @oa, 'some_policy_machine_uuid1')
+      policy_machine_storage_adapter.add_association(@ua2, Set.new([@w, @e]), @oa, 'some_policy_machine_uuid1')
+      assocs_with_w = policy_machine_storage_adapter.associations_with(@w)
+
+      assocs_with_w.size == 2
+      assocs_with_w[0][0].should == @ua
+      assocs_with_w[0][1].to_a.should == [@w]
+      assocs_with_w[0][2].should == @oa
+      assocs_with_w[1][0].should == @ua2
+      assocs_with_w[1][1].to_a.should == [@w, @e]
+      assocs_with_w[1][2].should == @oa
+
+    end
+
+  end
+
+  describe '#policy_classes_for_object_attribute' do
+    before do
+      @oa = policy_machine_storage_adapter.add_object_attribute('some_oa', 'some_policy_machine_uuid1')
+      @pc1 = policy_machine_storage_adapter.add_policy_class('some_pc1', 'some_policy_machine_uuid1')
+      @pc2 = policy_machine_storage_adapter.add_policy_class('some_pc2', 'some_policy_machine_uuid1')
+      @pc3 = policy_machine_storage_adapter.add_policy_class('some_pc3', 'some_policy_machine_uuid1')
+    end
+
+    it 'returns empty array if object is in no policy classes' do
+      policy_machine_storage_adapter.policy_classes_for_object_attribute(@oa).should == []
+    end
+
+    it 'returns array of policy class(es) if object is in policy class(es)' do
+      policy_machine_storage_adapter.assign(@oa, @pc1)
+      policy_machine_storage_adapter.assign(@oa, @pc3)
+      policy_machine_storage_adapter.policy_classes_for_object_attribute(@oa).should == [@pc1, @pc3]
+    end
+
+  end
+
+  describe '#transaction' do
+    it 'executes the block' do
+      if_implements(policy_machine_storage_adapter, :transaction){}
+      policy_machine_storage_adapter.transaction do
+        @oa = policy_machine_storage_adapter.add_object_attribute('some_oa', 'some_policy_machine_uuid1')
+        @pc1 = policy_machine_storage_adapter.add_policy_class('some_pc1', 'some_policy_machine_uuid1')
+        policy_machine_storage_adapter.assign(@oa, @pc1)
+      end
+      policy_machine_storage_adapter.policy_classes_for_object_attribute(@oa).should == [@pc1]
+    end
+
+    it 'rolls back the block on error' do
+      if_implements(policy_machine_storage_adapter, :transaction){}
+      @oa = policy_machine_storage_adapter.add_object_attribute('some_oa', 'some_policy_machine_uuid1')
+      @pc1 = policy_machine_storage_adapter.add_policy_class('some_pc1', 'some_policy_machine_uuid1')
+      policy_machine_storage_adapter.assign(@oa, @pc1)
+      expect do
+        policy_machine_storage_adapter.transaction do
+          @pc2 = policy_machine_storage_adapter.add_policy_class('some_pc2', 'some_policy_machine_uuid1')
+          policy_machine_storage_adapter.assign(@oa, @pc2)
+          policy_machine_storage_adapter.assign(@oa, :invalid_policy_class)
+        end
+      end.to raise_error(ArgumentError)
+      policy_machine_storage_adapter.find_all_of_type_policy_class.should == [@pc1]
+      policy_machine_storage_adapter.policy_classes_for_object_attribute(@oa).should == [@pc1]
+    end
+  end
+
+end

data/spec/support/shared_examples_storage_adapter_public_methods.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+shared_examples "a policy machine storage adapter with required public methods" do
+  let(:policy_machine_storage_adapter) { described_class.new }
+
+  policy_element_types = ::PolicyMachine::POLICY_ELEMENT_TYPES
+  required_public_methods = []
+  policy_element_types.each do |pe_type|
+    required_public_methods << "add_#{pe_type}"
+    required_public_methods << "find_all_of_type_#{pe_type}"
+  end
+  required_public_methods += %w(assign connected? unassign delete update element_in_machine? add_association associations_with policy_classes_for_object_attribute transaction)
+
+  required_public_methods.each do |req_public_method|
+    it "responds to #{req_public_method}" do
+      policy_machine_storage_adapter.should respond_to(req_public_method)
+    end
+  end
+
+end

data/spec/support/storage_adapter_helpers.rb

@@ -0,0 +1,7 @@
+# This file contains helper methods to test policy machine integration with storage adapters.
+
+def if_implements(storage_adapter, meth, *args,&block)
+  storage_adapter.send(meth,*args,&block)
+rescue NotImplementedError => e
+  pending(e.message)
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+# require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "policy_machine"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,42 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+# 
+# Install the MYSQL driver
+#   gem install mysql2
+#
+# Ensure the MySQL gem is defined in your Gemfile
+#   gem 'mysql2'
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_development
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_test
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+
+production:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_production
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock