soar-registry-identity 4.0.3 → 5.0.0

data/lib/soar/registry/identity/test/fixtures/client_table.sql

@@ -0,0 +1,91 @@
+DROP TABLE IF EXISTS `Client`;
+CREATE TABLE `Client` (
+  `ID` int(11) NOT NULL AUTO_INCREMENT,
+  `Timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  `Client_Number` varchar(15) NOT NULL DEFAULT '',
+  `Privil` varchar(15) NOT NULL DEFAULT '',
+  `Active` enum('0','1') NOT NULL DEFAULT '0',
+  `ActiveUntil` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `MaxDomains` int(11) NOT NULL DEFAULT '100',
+  `Title` varchar(10) DEFAULT NULL,
+  `First_Name` varchar(70) DEFAULT NULL,
+  `Surname` varchar(70) DEFAULT NULL,
+  `Company` varchar(70) DEFAULT NULL,
+  `Street` varchar(70) DEFAULT NULL,
+  `Postal_Code` varchar(10) DEFAULT NULL,
+  `Suburb` varchar(70) NOT NULL DEFAULT '',
+  `Country` varchar(70) NOT NULL DEFAULT '0',
+  `City` varchar(70) NOT NULL DEFAULT '',
+  `CountryGroup` enum('0','1','2') NOT NULL DEFAULT '0',
+  `Telephone` varchar(50) DEFAULT NULL,
+  `Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `ID_Number` varchar(30) DEFAULT NULL,
+  `Date_Of_Birth` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `Fax` varchar(50) DEFAULT NULL,
+  `RipeHandle` varchar(16) NOT NULL DEFAULT '',
+  `Login` varchar(15) DEFAULT NULL,
+  `Password` varchar(30) DEFAULT NULL,
+  `FromEmail1` varchar(40) NOT NULL DEFAULT '',
+  `FromEmail2` varchar(40) DEFAULT NULL,
+  `FromEmail3` varchar(40) DEFAULT NULL,
+  `PublicKey` mediumtext NOT NULL,
+  `Newsletter` enum('0','1') NOT NULL DEFAULT '0',
+  `Notice` enum('0','1') NOT NULL DEFAULT '1',
+  `Notifyemail` varchar(100) DEFAULT NULL,
+  `Notifyemail_Robot` varchar(100) NOT NULL DEFAULT '',
+  `Notifyemail_Traffic` varchar(100) DEFAULT NULL,
+  `Notifyemail_Invoice` text,
+  `FreeTraffic` decimal(4,2) DEFAULT NULL,
+  `Bank_Branch_Code` varchar(8) DEFAULT NULL,
+  `Bank_Account_Number` varchar(30) DEFAULT NULL,
+  `Bank_Account_Holder` varchar(60) DEFAULT NULL,
+  `Bank_Account_Type` enum('0','1','2','3','4','5') NOT NULL DEFAULT '0',
+  `Bank_Name` varchar(60) NOT NULL DEFAULT '',
+  `Bank_Branch_Location` varchar(60) NOT NULL DEFAULT '',
+  `Reseller` enum('0','1') NOT NULL DEFAULT '0',
+  `Reseller_Proof` varchar(60) NOT NULL DEFAULT '',
+  `CreditCardNumber` varchar(30) NOT NULL DEFAULT '',
+  `CreditCardExpiration` varchar(6) NOT NULL DEFAULT '',
+  `CreditCardName` varchar(15) NOT NULL DEFAULT '',
+  `payment_method` enum('Unspecified','Cash','Debit Order') NOT NULL DEFAULT 'Unspecified',
+  `Mother_ID` varchar(12) NOT NULL DEFAULT '',
+  `ChargeVAT` enum('0','1') NOT NULL DEFAULT '1',
+  `Summary_Invoice` enum('0','1') NOT NULL DEFAULT '0',
+  `Separate_Invoice` enum('0','1') NOT NULL DEFAULT '0',
+  `Email_Format` enum('0','1','2','3') NOT NULL DEFAULT '1',
+  `Dedi_Graph` enum('0','1') NOT NULL DEFAULT '1',
+  `TaxID` varchar(20) NOT NULL DEFAULT '',
+  `Discount` decimal(4,2) DEFAULT NULL,
+  `ChargeRobotSetup` enum('0','1','2') DEFAULT NULL,
+  `ClientCreated` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `Comment` text,
+  `Advice` mediumtext NOT NULL,
+  `Vat_Number` varchar(30) DEFAULT NULL,
+  `Rejection_Counter` tinyint(11) DEFAULT '0',
+  `Marketing` enum('Print','Brainstorm','ComputerActive','Google','ITWeb','Mouth','Website','Search','Designer','Hetzner','Other','SA Computer Magazine','Entrepreneur Magazine','Financial Mail') DEFAULT NULL,
+  `Marketing_other` mediumtext,
+  `Billing_First_Name` varchar(70) NOT NULL DEFAULT '',
+  `Billing_Surname` varchar(70) NOT NULL DEFAULT '',
+  `Billing_Telephone` varchar(50) NOT NULL DEFAULT '',
+  `Billing_Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `Tech_First_Name` varchar(70) NOT NULL DEFAULT '',
+  `Tech_Surname` varchar(70) NOT NULL DEFAULT '',
+  `Notifyemail_Tech` varchar(100) NOT NULL DEFAULT '',
+  `Tech_Telephone` varchar(50) NOT NULL DEFAULT '',
+  `Tech_Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `Verified` enum('0','1') NOT NULL DEFAULT '1',
+  `mass_update_notification_sent` enum('1','2','3','more','no') NOT NULL DEFAULT 'no',
+  `mass_update_submission_sent` enum('yes','no') NOT NULL DEFAULT 'no',
+  `contact_Confirmed` enum('True','False') NOT NULL DEFAULT 'True',
+  `is_test_profile` enum('0','1') DEFAULT '0',
+  `Google` enum('None','Eligible','Emailed','Issued') NOT NULL DEFAULT 'None',
+  `Google_Value_ID` int(11) NOT NULL DEFAULT '0',
+  `Google_Expiry` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `app_installer_active` tinyint(1) DEFAULT '1',
+  PRIMARY KEY (`ID`),
+  KEY `Login` (`Login`),
+  KEY `Password` (`Password`),
+  KEY `Notifyemail_Invoice` (`Notifyemail_Invoice`(20)),
+  KEY `Client_Number` (`Client_Number`)
+) ENGINE=InnoDB AUTO_INCREMENT=185532 DEFAULT CHARSET=latin1;
+

data/lib/soar/registry/identity/test/fixtures/roles_table.json

@@ -0,0 +1,27 @@
+{
+    "table_name": "identity_roles",
+    "key_schema": [
+        {
+            "attribute_name": "identity_uuid",
+            "key_type": "HASH" 
+        },
+        {
+            "attribute_name": "identity_role",
+            "key_type": "RANGE" 
+        }
+    ],
+    "attribute_definitions": [
+        {
+            "attribute_name": "identity_uuid",
+            "attribute_type": "S"
+        },
+        {
+            "attribute_name": "identity_role",
+            "attribute_type": "S"
+        }
+    ],
+    "provisioned_throughput": { 
+        "read_capacity_units": 10,
+        "write_capacity_units": 10
+    }
+}

data/lib/soar/registry/identity/test/orchestration_provider/customer/uuid.rb

@@ -0,0 +1,201 @@
+require 'faker'
+require 'soar/registry/identity'
+require 'soar/registry/directory'
+require 'soar/authentication/identity_uuid_translator/provider/customer'
+require 'soar/authentication/identity_uuid_translator/uuid_generator'
+
+module Soar
+  module Registry
+    module Identity
+      module Test
+        module OrchestrationProvider
+          module Customer
+            class Uuid
+
+              def initialize
+                Faker::UniqueGenerator.clear
+                @identity = {
+                  ID: Faker::Number.unique.number(4).to_i,
+                  First_Name: Faker::Name.unique.first_name,
+                  Surname: Faker::Name.unique.last_name,
+                  Notifyemail_Invoice: "#{Faker::Internet.unique.email}",
+                  Client_Number: "C#{Faker::Number.unique.number(10)}"
+                }
+                @identity_uuid = Soar::Authentication::IdentityUuidTranslator::UuidGenerator.generate("#{Soar::Authentication::IdentityUuidTranslator::Provider::Customer::PREFIX}#{@identity[:ID]}")
+              end
+
+              def given_identity_directory
+                wait_for_database do
+                  @identity_directory_config = YAML.load_file("config/#{ENV['CUSTOMER_DIRECTORY_CONFIG_FILE']}")
+                  @identity_directory =  Soar::Registry::Directory.new(
+                    Soar::Registry::Directory::Provider::Mysql.new(@identity_directory_config['config'].map { |k, v| [k.to_sym, v] }.to_h)
+                  )
+                end
+              end
+
+              def given_roles_directory
+                @roles_directory_config = YAML.load_file("config/#{ENV['ROLES_DIRECTORY_CONFIG_FILE']}")
+                @roles_directory = Soar::Registry::Directory.new(
+                  Soar::Registry::Directory::Provider::DynamoDb.new(@roles_directory_config['config'].map { |k, v| [k.to_sym, v]}.to_h)
+                )
+              end
+
+              def given_roles
+                @roles = generate_roles()
+                wait_for_database {
+                  create_roles_table(@roles_directory, @roles_directory_config)
+                  populate_roles_table(@roles_directory, @roles, @identity_uuid)
+                }
+              end
+
+              def given_role_with_attributes
+                @roles = generate_roles()
+                @roles[0][:attributes] = {
+                  profiles: [@identity[:Client_Number], "C#{Faker::Number.unique.number(10)}"]
+                }
+                wait_for_database {
+                  create_roles_table(@roles_directory, @roles_directory_config)
+                  populate_roles_table(@roles_directory, @roles, @identity_uuid)
+                }
+              end
+
+              def given_identity
+                wait_for_database do
+                  create_identity_table(@identity_directory)
+                  @identity_directory.put(@identity)
+                end
+              end
+
+              def given_identity_registry
+                identity_provider = Soar::Registry::Identity::Provider::Customer::Uuid.new({
+                  identity: {
+                    directory: @identity_directory,
+                    fetch_index: 'ID',
+                    search_index: 'Notifyemail_Invoice'
+                  },
+                  roles: {
+                    directory: @roles_directory,
+                    fetch_index: ['identity_uuid', 'identity_role'],
+                    search_index: 'identity_uuid'
+                  }
+                })
+
+                @idr = Soar::Registry::Identity.new(identity_provider)
+              end
+
+              def get_roles
+                @result = @idr.get_roles(@identity_uuid) 
+              end
+
+              def get_role_attributes
+                @result = @idr.get_attributes(@identity_uuid, @roles.nil? ? Faker::Company.unique.profession : @roles[0][:role])
+              end
+
+              def get_identity_attributes
+                @result = @idr.get_attributes(@identity_uuid)
+              end
+
+              def identity_attributes?
+                roles = {}
+                @roles.each do |entry| 
+                  roles[entry[:role]] = {}
+                end if not @roles.nil?
+                expectation = {
+                  "identity_uuid" => @identity_uuid,
+                  "firstname" => @identity[:First_Name],
+                  "lastname" => @identity[:Surname], 
+                  "email" => @identity[:Notifyemail_Invoice],
+                  "roles" => roles
+                }
+                @result == expectation
+              end
+
+              def nil?
+                @result == nil
+              end
+              
+              def role_with_empty_attributes?
+                @result == {
+                  @roles[0][:role] => {}
+                }
+              end
+
+              def role_with_attributes?
+                role_with_attributes = {
+                  @roles[0][:role] => Hashie.stringify_keys(@roles[0][:attributes])
+                }
+                @result == role_with_attributes
+              end
+
+              def roles?
+                roles = @roles.map do |entry| 
+                  entry[:role]
+                end
+                @result.sort == roles.sort
+              end
+
+              def no_roles?
+                @result == []
+              end
+
+              def identity_error?
+                # this is not currently possible
+                @result == []
+              end
+
+              private
+
+              def generate_roles()
+                return [{
+                  source: "#{Soar::Authentication::IdentityUuidTranslator::Provider::Customer::PREFIX}#{@identity[:ID]}",
+                  role: Soar::Authentication::IdentityUuidTranslator::Provider::Customer::ROLE
+                },{
+                  role: Faker::Company.unique.profession
+                }]
+              end
+
+              def populate_roles_table(roles_directory, roles, identity_uuid)
+                  roles.each { |role|
+                    entry = {
+                      "identity_uuid" => identity_uuid,
+                      "identity_role" => role[:role]
+                    }
+                    entry['identity_source'] = role[:source] if role.key?(:source)
+                    entry['identity_role_attributes'] = role[:attributes] if role.key?(:attributes)
+                    roles_directory.put(entry)
+                  }
+              end
+
+              def create_roles_table(roles_directory, roles_directory_config)
+                roles_directory.provider.recreate_table({
+                  name: roles_directory_config['config']['table']['name'],
+                  structure: JSON.parse(File.read("lib/soar/registry/identity/test/fixtures/roles_table.json"))
+                })
+              end
+
+              def create_identity_table(identity_directory)
+                identity_directory.provider.client.query("DROP TABLE IF EXISTS `Client`")
+                identity_directory.provider.client.query("CREATE TABLE Client ( ID int(11) NOT NULL AUTO_INCREMENT, Client_Number varchar(15) NOT NULL DEFAULT '', First_Name varchar(70) DEFAULT NULL, Surname varchar(70) DEFAULT NULL, Notifyemail_Invoice text, PRIMARY KEY (ID), KEY Notifyemail_Invoice (Notifyemail_Invoice(20)), KEY Client_Number (Client_Number))")
+              end
+
+              def deep_copy(o)
+                Marshal.load(Marshal.dump(o))
+              end
+
+              def wait_for_database
+                return 10.times do |i|
+                  begin
+                    break yield
+                  rescue Soar::Registry::Directory::Error::NetworkingError, Net::LDAP::Error => e
+                    sleep(10)
+                  end
+                end
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/identity/test/orchestration_provider/staff/uuid.rb

@@ -0,0 +1,207 @@
+require 'faker'
+require 'soar/registry/identity'
+require 'soar/registry/directory'
+require 'securerandom'
+require 'soar/authentication/identity_uuid_translator'
+
+module Soar
+  module Registry
+    module Identity
+      module Test
+        module OrchestrationProvider
+          module Staff
+            class Uuid
+
+              def initialize
+                Faker::UniqueGenerator.clear
+                @identity_directory_config = YAML.load_file("config/#{ENV['STAFF_DIRECTORY_CONFIG_FILE']}")
+                firstname = Faker::Name.first_name
+                lastname = Faker::Name.last_name
+                @identity = {
+                  dn: "cn=#{firstname} #{lastname},#{@identity_directory_config['config']['base']}",
+                  attributes: {
+                    cn: "#{firstname} #{lastname}",
+                    givenName: firstname,
+                    mail: "#{firstname.downcase}.#{lastname.downcase}@hetzner.co.za",
+                    objectclass: ["inetOrgPerson", "top"],
+                    sn: lastname
+                  }
+                }
+
+                @identity_uuid = SecureRandom.uuid
+                
+              end
+
+              def given_roles_directory
+                @roles_directory_config = YAML.load_file("config/#{ENV['ROLES_DIRECTORY_CONFIG_FILE']}")
+                @roles_directory = Soar::Registry::Directory.new(
+                  Soar::Registry::Directory::Provider::DynamoDb.new(@roles_directory_config['config'].map { |k, v| [k.to_sym, v]}.to_h )
+                )
+              end
+
+              def given_identity_directory
+                @identity_directory =  Soar::Registry::Directory.new(
+                  Soar::Registry::Directory::Provider::Ldap.new(@identity_directory_config['config'].map{ |k, v| [k.to_sym, v]}.to_h)
+                )
+
+              end
+
+              def given_identity
+                wait_for_database do
+                  @identity_directory.provider.delete(@identity[:dn])
+                  @identity_directory.put(@identity)
+                  @identity_uuid = @identity_directory.search('mail', @identity[:attributes][:mail])[0][:entryuuid]
+                end
+              end
+
+              def given_roles
+                @roles = generate_roles()
+                wait_for_database do
+                  create_roles_database(@roles_directory_config, @roles_directory)
+                  populate_roles_database(@roles_directory, @roles, @identity_uuid)
+                end
+              end
+
+              def given_role_with_attributes
+                @roles = generate_roles()
+                @roles[0][:attributes] = {
+                  Faker::Hacker.noun => Faker::Hacker.verb
+                }
+                wait_for_database do
+                  create_roles_database(@roles_directory_config, @roles_directory)
+                  populate_roles_database(@roles_directory, @roles, @identity_uuid)
+                end
+              end
+
+              def given_identity_registry
+                identity_provider = Soar::Registry::Identity::Provider::Staff::Uuid.new({
+                  identity: {
+                    directory: @identity_directory,
+                    fetch_index: 'entryuuid',
+                    search_index: 'mail'
+                  },
+                  roles: {
+                    directory: @roles_directory,
+                    fetch_index: ['identity_uuid', 'identity_role'],
+                    search_index: 'identity_uuid'
+                  }
+                })
+
+                @idr = Soar::Registry::Identity.new(identity_provider)
+              end
+
+              def get_roles
+                begin
+                  @result = @idr.get_roles(@identity_uuid) 
+                rescue SoarIdm::IdentityError => e
+                  @error = e
+                end
+              end
+
+              def get_identity_attributes
+                @result = @idr.get_attributes(@identity_uuid)
+              end
+
+              def get_role_attributes
+                @result = @idr.get_attributes(@identity_uuid, @roles.nil? ? Faker::Company.unique.profession : @roles[0][:role])
+              end
+
+              def identity_attributes?
+                roles = {}
+                @roles.each do |entry| 
+                  roles[entry[:role]] = {}
+                end if not @roles.nil?
+                @result == {
+                  "identity_uuid" => @identity_uuid,
+                  "firstname" => @identity[:attributes][:givenName],
+                  "lastname" => @identity[:attributes][:sn],
+                  "email" => @identity[:attributes][:mail],
+                  "roles" => roles
+                }
+              end
+
+              def role_with_attributes?
+                role_with_attributes = {
+                  @roles[0][:role] => Hashie.stringify_keys(@roles[0][:attributes])
+                }
+                @result == role_with_attributes
+              end
+
+              def nil?
+                @result == nil
+              end
+              
+              def role_with_empty_attributes?
+                @result == {
+                  @roles[0][:role] => {}
+                }
+              end
+
+              def roles?
+
+                roles = @roles.map do |entry| 
+                  entry[:role]
+                end
+                @result.sort == roles.sort
+              end
+
+              def no_roles?
+                @result == []
+              end
+
+              def identity_error?
+                @error.is_a?(SoarIdm::IdentityError)
+              end
+
+              private
+
+              def create_roles_database(directory_config, directory)
+                directory.provider.recreate_table({
+                  name: directory_config['config']['table']['name'],
+                  structure: JSON.parse(File.read("lib/soar/registry/identity/test/fixtures/roles_table.json"))
+                })
+              end
+
+              def populate_roles_database(roles_directory, roles, identity_uuid)
+                  roles.each do |role|
+                    entry = {
+                      "identity_uuid" => identity_uuid,
+                      "identity_role" => role[:role]
+                    }
+                    entry['identity_source'] = role[:source] if role.key?(:source)
+                    entry['identity_role_attributes'] = role[:attributes] if role.key?(:attributes)
+                    roles_directory.put(entry)
+                  end
+              end
+
+              def generate_roles()
+                roles = [{
+                  role: Faker::Company.unique.profession
+                }, {
+                  role: Faker::Company.unique.profession
+                }, {
+                  role: Faker::Company.unique.profession
+                }, {
+                  role: Faker::Company.unique.profession
+                }]
+                roles[0][:source] = "#{Soar::Authentication::IdentityUuidTranslator::Provider::Staff::PREFIX}#{@identity_uuid}"
+                return roles
+              end
+
+              def wait_for_database
+                return 10.times do |i|
+                  begin
+                    break yield
+                  rescue Soar::Registry::Directory::Error::NetworkingError, Net::LDAP::Error => e
+                    sleep(10)
+                  end
+                end
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end