Merge branch 'main' into feature/scheduled-event

README.md

@@ -1,4 +1,4 @@
-[![Coverage Status](https://coveralls.io/repos/github/SFDO-Tooling/Snowfakery/badge.svg?branch=master)](https://coveralls.io/github/SFDO-Tooling/Snowfakery?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/SFDO-Tooling/Snowfakery/badge.svg?branch=main)](https://coveralls.io/github/SFDO-Tooling/Snowfakery?branch=main)
 
 # Snowfakery Documentation
 

docs/extending.md

@@ -118,7 +118,6 @@ represents the values that would be available to a formula running in the same c
 and `self.context.current_filename` which is the filename of the YAML file being
 processed.
 
-
 ### Plugin Function Return Values
 
 Plugins can return normal Python primitive types, `datetime.date`, `ObjectRow` or `PluginResult` objects. `ObjectRow` objects represent new output records/objects. `PluginResult` objects

docs/salesforce.md

@@ -352,24 +352,21 @@ There is also an alternate syntax which allows nicknaming:
 Files can be used as Salesforce ContentVersions like this:
 
 ```yaml
-- plugin: snowfakery.standard_plugins.base64.Base64
-- plugin: snowfakery.standard_plugins.file.File
+# examples/salesforce/ContentVersion.recipe.yml
+- plugin: snowfakery.standard_plugins.Salesforce
 - object: Account
   nickname: FileOwner
   fields:
     Name:
       fake: company
 - object: ContentVersion
-  nickname: FileAttachment
   fields:
     Title: Attachment for ${{Account.Name}}
     PathOnClient: example.pdf
-    Description: example.pdf
+    Description: The example.pdf file
     VersionData:
-      Base64.encode:
-        - File.file_data:
-            encoding: binary
-            file: ${{PathOnClient}}
+      Salesforce.ContentFile:
+        file: example.pdf
     FirstPublishLocationId:
       reference: Account
 ```

examples/base64_file.recipe.yml

@@ -0,0 +1,32 @@
+- plugin: snowfakery.standard_plugins.base64.Base64
+- plugin: snowfakery.standard_plugins.file.File
+- plugin: snowfakery.standard_plugins.Salesforce
+- object: Account
+  nickname: FileOwner
+  fields:
+    Name:
+      fake: company
+- object: ContentVersion
+  nickname: FileAttachment
+  fields:
+    Title: Attachment for ${{Account.Name}}
+    PathOnClient: salesforce/example.pdf
+    Description: example.pdf
+    VersionData:
+      Base64.encode:
+        - File.file_data:
+            encoding: binary
+            file: ${{PathOnClient}}
+    FirstPublishLocationId:
+      reference: Account
+- object: ContentVersion
+  nickname: FileAttachment2
+  fields:
+    Title: Attachment for ${{Account.Name}}
+    PathOnClient: salesforce/example.pdf
+    Description: example.pdf
+    VersionData:
+      Salesforce.ContentFile:
+        file: ${{PathOnClient}}
+    FirstPublishLocationId:
+      reference: Account

examples/salesforce/ContentVersion.recipe.yml

@@ -1,20 +1,16 @@
-- plugin: snowfakery.standard_plugins.base64.Base64
-- plugin: snowfakery.standard_plugins.file.File
+- plugin: snowfakery.standard_plugins.Salesforce
 - object: Account
   nickname: FileOwner
   fields:
     Name:
       fake: company
 - object: ContentVersion
-  nickname: FileAttachment
   fields:
     Title: Attachment for ${{Account.Name}}
     PathOnClient: example.pdf
-    Description: example.pdf
+    Description: The example.pdf file
     VersionData:
-      Base64.encode:
-        - File.file_data:
-            encoding: binary
-            file: ${{PathOnClient}}
+      Salesforce.ContentFile:
+        file: example.pdf
     FirstPublishLocationId:
       reference: Account

snowfakery/plugins.py

@@ -140,6 +140,10 @@ def evaluate(self, field_definition):
     def current_filename(self):
         return self.interpreter.current_context.current_template.filename
 
+    @property
+    def current_filename(self):
+        return self.interpreter.current_context.current_template.filename
+
 
 def lazy(func: Any) -> Callable:
     """A lazy function is one that expects its arguments to be unparsed"""

snowfakery/standard_plugins/Salesforce.py

@@ -2,6 +2,7 @@
 from logging import getLogger
 from tempfile import TemporaryDirectory
 from pathlib import Path
+from base64 import b64encode
 
 from snowfakery.plugins import ParserMacroPlugin, memorable
 from snowfakery.data_generator_runtime_object_model import (
@@ -266,60 +267,6 @@ def _parse_special_args(self, args):
 
         return sobj, nickname
 
-    # FIXME: This code is not documented or tested
-    def ContentFile(self, context, args) -> ObjectTemplate:
-        return {
-            "Base64.encode": [
-                {"File.file_data": {"encoding": "binary", "file": args.get("path")}}
-            ]
-        }
-
-    def PermissionSetAssignments(self, context, args) -> ObjectTemplate:
-        names = args.get("names")
-        if not isinstance(names, str):
-            raise DataGenValueError(
-                f"string `names` not specified for PermissionSetAssignments: {names}"
-            )
-        names = names.split(",")
-        line_info = context.line_num()
-        decls = [self._generate_psa(context, line_info, name) for name in names]
-
-        return ObjectTemplate(
-            "__wrapper_for_permission_sets",
-            filename=line_info["filename"],
-            line_num=line_info["line_num"],
-            friends=decls,
-        )
-
-    def _generate_psa(self, context, line_info, name):
-        fields = {"AssigneeId": ("Use")}
-
-        query = f"PermissionSet where Name = '{name}'"
-
-        fields = [
-            FieldFactory(
-                "PermissionSetId",
-                StructuredValue(
-                    "SalesforceQuery.find_record", {"from": query}, **line_info
-                ),
-                **line_info,
-            ),
-            FieldFactory(
-                "AssigneeId",
-                StructuredValue("reference", ["User"], **line_info),
-                **line_info,
-            ),
-        ]
-
-        new_template = ObjectTemplate(
-            "PermissionSetAssignment",
-            filename=line_info["filename"],
-            line_num=line_info["line_num"],
-            fields=fields,
-        )
-        context.register_template(new_template)
-        return new_template
-
     class Functions:
         @memorable
         def ProfileId(self, name):
@@ -328,6 +275,12 @@ def ProfileId(self, name):
 
         Profile = ProfileId
 
+        def ContentFile(self, file: str):
+            template_path = Path(self.context.current_filename).parent
+
+            with open(template_path / file, "rb") as data:
+                return b64encode(data.read()).decode("ascii")
+
 
 class SOQLDatasetImpl(DatasetBase):
     iterator = None

tests/test_salesforce_gen.py

@@ -9,13 +9,13 @@
 
 class TestSalesforceGen:
     def test_content_version(self, generated_rows):
-        content_version = "examples/salesforce/ContentVersion.recipe.yml"
+        content_version = "examples/base64_file.recipe.yml"
         generate_data(content_version)
-        b64data = generated_rows.table_values("ContentVersion", 0)["VersionData"]
-        rawdata = b64decode(b64data)
-        assert rawdata.startswith(b"%PDF-1.3")
-        assert b"Helvetica" in rawdata
-
+        for i in range(0, 2):
+            b64data = generated_rows.table_values("ContentVersion", i)["VersionData"]
+            rawdata = b64decode(b64data)
+            assert rawdata.startswith(b"%PDF-1.3")
+            assert b"Helvetica" in rawdata
 
 class TestSalesforcePlugin:
     @skip_if_cumulusci_missing