From cdd135866490db4db705a0371d6d181928beda46 Mon Sep 17 00:00:00 2001
From: thomashaw <thomashaw@gmail.com>
Date: Fri, 17 Feb 2023 10:24:26 +0000
Subject: [PATCH] Future proofing Faker modules with symbol parameters
 (deprecated calls break with faker gem newer than 3.0.0).

(cherry picked from commit 7a30703348a84b461d1500dcf5fe6ae54bfc1394)
---
 .../content/address_us/secgen_local/local.rb  |  2 +-
 .../business_email/secgen_local/local.rb      |  2 +-
 .../email_address/secgen_local/local.rb       |  2 +-
 .../hipster_paragraph/secgen_local/local.rb   |  2 +-
 .../lipsum_paragraph/secgen_local/local.rb    |  2 +-
 scenarios/tests/test_faker_gems.xml           | 41 +++++++++++++++++++
 6 files changed, 46 insertions(+), 5 deletions(-)
 create mode 100644 scenarios/tests/test_faker_gems.xml

diff --git a/modules/generators/content/address_us/secgen_local/local.rb b/modules/generators/content/address_us/secgen_local/local.rb
index 24857f7c1..5a304e921 100644
--- a/modules/generators/content/address_us/secgen_local/local.rb
+++ b/modules/generators/content/address_us/secgen_local/local.rb
@@ -9,7 +9,7 @@ class USAddressGenerator < StringGenerator
   end
 
   def generate
-    street_name = [Faker::Address.street_address, Faker::Address.street_address(true)].sample
+    street_name = [Faker::Address.street_address, Faker::Address.street_address(include_secondary: true)].sample
     city = Faker::Address.city
     state = Faker::Address.state
     zip_code = Faker::Address.zip
diff --git a/modules/generators/content/business_email/secgen_local/local.rb b/modules/generators/content/business_email/secgen_local/local.rb
index b80908f4a..aa1ebf505 100644
--- a/modules/generators/content/business_email/secgen_local/local.rb
+++ b/modules/generators/content/business_email/secgen_local/local.rb
@@ -21,7 +21,7 @@ class BusinessEmailEncoder < StringEncoder
     self.business_name = Faker::Company::name if self.business_name.empty?
 
     # generate parts of email
-    local_part = Faker::Internet.user_name(self.name, ['-'])
+    local_part = Faker::Internet.user_name(specifier: self.name, separators: ['-'])
 
     if self.domain.empty?
       self.domain = craft_domain
diff --git a/modules/generators/content/email_address/secgen_local/local.rb b/modules/generators/content/email_address/secgen_local/local.rb
index 6cab8a20d..fcdd6c993 100644
--- a/modules/generators/content/email_address/secgen_local/local.rb
+++ b/modules/generators/content/email_address/secgen_local/local.rb
@@ -15,7 +15,7 @@ class EmailAddressGenerator < StringEncoder
     if self.name.empty?
       self.name = nil
     end
-    self.outputs << Faker::Internet.email(self.name)
+    self.outputs << Faker::Internet.email(name: self.name)
   end
 
   def get_options_array
diff --git a/modules/generators/content/hipster_paragraph/secgen_local/local.rb b/modules/generators/content/hipster_paragraph/secgen_local/local.rb
index 3b8f64dbf..140b5e3bd 100644
--- a/modules/generators/content/hipster_paragraph/secgen_local/local.rb
+++ b/modules/generators/content/hipster_paragraph/secgen_local/local.rb
@@ -10,7 +10,7 @@ class HipsterParagraphGenerator < ParagraphGenerator
   end
 
   def encode_all
-    self.outputs << Faker::Hipster.paragraphs(self.paragraph_count[0].to_i).join
+    self.outputs << Faker::Hipster.paragraphs(number: self.paragraph_count[0].to_i).join
   end
 
 end
diff --git a/modules/generators/content/lipsum_paragraph/secgen_local/local.rb b/modules/generators/content/lipsum_paragraph/secgen_local/local.rb
index 4954b06b2..31e3ff7a3 100644
--- a/modules/generators/content/lipsum_paragraph/secgen_local/local.rb
+++ b/modules/generators/content/lipsum_paragraph/secgen_local/local.rb
@@ -10,7 +10,7 @@ class LipsumParagraphGenerator < ParagraphGenerator
   end
 
   def encode_all
-    self.outputs << Faker::Lorem.paragraphs(self.paragraph_count[0].to_i).join
+    self.outputs << Faker::Lorem.paragraphs(number: self.paragraph_count[0].to_i).join
   end
 
 end
diff --git a/scenarios/tests/test_faker_gems.xml b/scenarios/tests/test_faker_gems.xml
new file mode 100644
index 000000000..3c30b3535
--- /dev/null
+++ b/scenarios/tests/test_faker_gems.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+
+<scenario xmlns="http://www.github/cliffe/SecGen/scenario"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://www.github/cliffe/SecGen/scenario">
+  <system>
+    <system_name>testing_faker</system_name>
+    <base platform="linux" distro="Debian 7.8" type="server"/>
+
+    <input into_datastore="IP_addresses">
+      <value>172.17.0.0</value>
+    </input>
+
+    <input into_datastore="faker_gems_with_parameters">
+      <generator type="email_address"/>
+
+      <generator type="business_email">
+        <input into="name">
+          <value>Tom Shaw</value>
+        </input>
+        <input into="business_name">
+          <value>Leeds Beckett University</value>
+        </input>
+      </generator>
+
+      <generator module_path=".*username.*"/>
+      <generator module_path=".*hipster_paragraph.*"/>
+      <generator module_path=".*lipsum_paragraph.*"/>
+      <generator module_path=".*random_filename.*"/>
+      <generator module_path=".*address_us.*"/>
+
+    </input>
+
+  <network type="private_network">
+      <input into="IP_address">
+        <datastore access="0">IP_addresses</datastore>
+      </input>
+    </network>
+  </system>
+
+</scenario>