Implement all_fields test using new framework-tdl-7499

tests/sfbase.py

@@ -16,6 +16,14 @@ class SFBaseTest(BaseCase):
 
     salesforce_api = "BULK"
 
+    #TODO - TDL-23781: [tap-salesforce] QA: Get Custom fields and non-custom fields
+    custom_fields = {"Account": {'SLAExpirationDate__c', 'SLASerialNumber__c', 'UpsellOpportunity__c', 'CustomerPriority__c', 'NumberofLocations__c', 'Active__c', 'SLA__c'},
+            'Contact': {'Languages__c', 'Level__c'}
+        }
+
+    non_custom_fields = {"Account": {'Description', 'BillingCountry', 'ParentId', 'Name', 'CleanStatus', 'ShippingStreet', 'IsDeleted', 'Jigsaw', 'BillingPostalCode', 'TickerSymbol', 'Fax', 'AccountSource', 'MasterRecordId', 'JigsawCompanyId', 'PhotoUrl', 'Rating', 'Tradestyle', 'Id', 'ShippingLatitude', 'CreatedById', 'CreatedDate', 'Website', 'ShippingPostalCode', 'ShippingState', 'OperatingHoursId', 'BillingLatitude', 'LastViewedDate', 'ShippingGeocodeAccuracy', 'LastReferencedDate', 'Ownership', 'NumberOfEmployees', 'DunsNumber', 'LastActivityDate', 'NaicsDesc', 'Sic', 'ShippingCity', 'ShippingLongitude', 'BillingGeocodeAccuracy', 'SicDesc', 'SystemModstamp', 'Type', 'Industry', 'BillingState', 'BillingStreet', 'BillingCity', 'YearStarted', 'DandbCompanyId', 'OwnerId', 'Site', 'LastModifiedDate', 'ShippingCountry', 'AnnualRevenue', 'AccountNumber', 'LastModifiedById', 'Phone', 'NaicsCode', 'BillingLongitude'}, 
+            "Contact": {'Description', 'EmailBouncedDate', 'LastCUUpdateDate', 'Email', 'MailingCity', 'OtherPhone', 'MailingStreet', 'Name', 'OtherCountry', 'CleanStatus', 'IsDeleted', 'Title', 'FirstName', 'Department', 'Jigsaw', 'Salutation', 'MailingCountry', 'OtherPostalCode', 'MobilePhone', 'Fax', 'MasterRecordId', 'PhotoUrl', 'OtherStreet', 'Id', 'OtherLongitude', 'MailingLatitude', 'LastName', 'CreatedById', 'OtherCity', 'CreatedDate', 'JigsawContactId', 'AccountId', 'LastViewedDate', 'AssistantPhone', 'LastCURequestDate', 'LastReferencedDate', 'OtherLatitude', 'LastActivityDate', 'LeadSource', 'EmailBouncedReason', 'SystemModstamp', 'OtherGeocodeAccuracy', 'OtherState', 'HomePhone', 'AssistantName', 'MailingGeocodeAccuracy', 'MailingState', 'IndividualId', 'IsEmailBounced', 'MailingPostalCode', 'OwnerId', 'LastModifiedDate', 'ReportsToId', 'MailingLongitude', 'Birthdate', 'LastModifiedById', 'Phone'} }
+
     @staticmethod
     def tap_name():
         """The name of the tap"""
@@ -844,6 +852,14 @@ def rest_only_streams(self):
             'UndecidedEventRelation',
         }
 
+    def expected_streams(self):
+        """A set of expected stream names"""
+        streams = set(self.expected_metadata().keys())
+
+        if self.salesforce_api == 'BULK':
+            return streams.difference(self.rest_only_streams())
+        return streams
+
     def set_replication_methods(self, conn_id, catalogs, replication_methods):
 
         replication_keys = self.expected_replication_keys()

tests/test_salesforce_all_fields_custom.py

@@ -0,0 +1,47 @@
+"""
+Test that with only custom fields selected for a stream automatic fields and custom fields  are still replicated
+"""
+import copy
+from tap_tester.base_suite_tests.all_fields_test import AllFieldsTest
+from sfbase import SFBaseTest
+from tap_tester.logger import LOGGER
+
+
+class SFCustomFieldsTest(AllFieldsTest, SFBaseTest):
+    """Test that with only custom fields selected for a stream automatic fields and custom fields are still replicated
+    TODO
+    This test coveres only BULK api and just couple of streams. We have separate cards to cover these cases
+    TDL-23653: [tap-salesforce]: QA - Add all the streams for the all_fields test
+    TDL-23654: [tap-salesforce]: QA - Add all-fields testcase for REST API streams
+    """
+
+    salesforce_api = 'BULK'
+
+    @staticmethod
+    def name():
+        return "tt_sf_all_fields_custom"
+
+    def streams_to_test(self):
+        streams = {'Account', 'Contact'}
+        return streams
+
+    @staticmethod
+    def streams_to_selected_fields():
+        return SFBaseTest.custom_fields
+
+    def test_custom_fields( self ):
+        for stream in self.streams_to_selected_fields():
+            expected_custom_fields = self.streams_to_selected_fields().get(stream, set() )
+            replicated_custom_fields = self.actual_fields.get(stream, set() ).difference(self.expected_automatic_fields(stream))
+
+            #Verify at least one custom field is replicated
+            self.assertIsNotNone( replicated_custom_fields, msg = f"Replication didn't return any custom fields for stream {stream}" )
+
+            #Verify only custom fields are replicated by checking the field name
+            self.assertTrue( self.verify_custom_fields( replicated_custom_fields ), "Replicated some fields that are not custom fields for stream {stream}" )
+
+            """
+            TODO: Add this assertion when we do  
+                  TDL-23781: [tap-salesforce] QA: Get Custom fields and non-custom fields
+            self.assertIsNone(replicated_custom_fields.difference(automatic_fields))
+            """

tests/test_salesforce_all_fields_non_custom.py

@@ -0,0 +1,47 @@
+"""
+Test that with only non-custom fields selected for a stream automatic fields and non custom fields  are still replicated
+"""
+
+from tap_tester.base_suite_tests.all_fields_test import AllFieldsTest
+from sfbase import SFBaseTest
+
+
+class SFNonCustomFieldsTest(AllFieldsTest, SFBaseTest):
+    """Test that with only non-custom fields selected for a stream automatic fields and non custom fields are still replicated
+    TODO
+    This test coveres only BULK api and just couple of streams. We have separate cards to cover these cases
+    TDL-23653: [tap-salesforce]: QA - Add all the streams for the all_fields test
+    TDL-23654: [tap-salesforce]: QA - Add all-fields testcase for REST API streams
+    """
+
+    salesforce_api = 'BULK'
+
+    @staticmethod
+    def name():
+        return "tt_sf_all_fields_non_custom"
+
+    def streams_to_test(self):
+        streams = {'Account', 'Contact'}
+        return streams
+
+    @staticmethod
+    def streams_to_selected_fields():
+        return SFBaseTest.non_custom_fields
+
+    def test_non_custom_fields( self ):
+        for stream in self.streams_to_selected_fields():
+            expected_non_custom_fields = self.streams_to_selected_fields().get(stream, set() )
+            replicated_non_custom_fields = self.actual_fields.get(stream, set() ).difference(self.expected_automatic_fields(stream))
+
+            #Verify at least one non-custom field is replicated
+            self.assertIsNotNone( replicated_non_custom_fields, msg = f"Replication didn't return any non-custom fields for stream {stream}" )
+
+            #Verify ustom fields are not replicated by checking the field name
+            self.assertFalse( self.verify_custom_fields( replicated_non_custom_fields ), "Replicated some fields that are custom fields for stream {stream}" )
+
+
+            """
+            TODO: Add this assertion when we do  
+                  TDL-23781: [tap-salesforce] QA: Get Custom fields and non-custom fields
+            self.assertIsNone(replicated_custom_fields.difference(automatic_fields))
+            """