[SalesForce] Custom Setting is null in test method even though I set a value

I want to update the Opportunity stage depending on a status field on the account. I have a validation rule that makes a date field on the opportunity mandatory for some stages. This validation rule should not apply to my update of the opportunity in the trigger, so I added a custom setting (type: hierarchy) to the validation rule and change its value in the code before and after updating the opportunity. I use a hierarchy setting as proposed here: https://salesforce.stackexchange.com/a/10353.

Here is the validation rule:

AND(
                NOT($Setup.ValidationRuleControl__c.Skip__c),
                ISNULL(ExpectedLiveDate__c), 
                OR(
                               ISPICKVAL(StageName,"Negotiation Started"), 
                               ISPICKVAL(StageName,"Negotiation Advanced"), 
                               ISPICKVAL(StageName,"Onboarding Started")
                ) 
)

If ValidationRuleControl__c.Skip__c is true, the ExpectedLiveDate__c is not mandatory.

Here is the piece of code that does the update of the opportunity:

    //turn off validation rules where the custom setting ValidationRuleControl__c is used
    public static void turnOffValidationRules() {
                ValidationRuleControl__c tempValidationRuleControl = ValidationRuleControl__c.getInstance();
                               if(tempValidationRuleControl == null) 
                                               tempValidationRuleControl = new ValidationRuleControl__c();
                               tempValidationRuleControl.Skip__c = true;
                               upsert tempValidationRuleControl;
    }

    //turn on validation rules again (after DML)
    public static void turnOnValidationRules() {
                               ValidationRuleControl__c tempValidationRuleControl = ValidationRuleControl__c.getInstance();
                               if(tempValidationRuleControl == null) 
                                               tempValidationRuleControl = new ValidationRuleControl__c();
                               tempValidationRuleControl.Skip__c = false;
                               upsert tempValidationRuleControl;
    }

                //updates a list of SObjects + error handling
    public static void updateSObjects(List<SObject> obsList, String errorMailSubject, String ErrorMailBody) {
                if (obsList != null)
                               if (!obsList.isEmpty()) {
                                               turnOffValidationRules();
                                               System.debug('>>>>>> ValidationRuleControl: ' + ValidationRuleControl__c.getInstance());
                                               //try to update all SObjects
                                                               [...]
                                               turnOnValidationRules();
                                               System.debug('>>>>>> ValidationRuleControl after turning on again: ' + ValidationRuleControl__c.getInstance());
                                               }
                                }
   }

This works fine when I test the function manually in the browser. But when I run my unit test, it fails because the validation rule prevents the opportunity update. I do set the custom setting ValidationRuleControl__c.Skip__c in my unit test to false to simulate the data. But at the moment of the update, ValidationRuleControl__c.Skip__c is actually null:

20:31:55.568 (6568908000)|VALIDATION_FORMULA|AND(
NOT($Setup.ValidationRuleControl__c.Skip__c),
ISNULL(ExpectedLiveDate__c), 
OR(
   ISPICKVAL(StageName,"Negotiation Started"), 
   ISPICKVAL(StageName,"Negotiation Advanced"), 
   ISPICKVAL(StageName,"Onboarding Started")
  ) 
)|StageName=Onboarding Started , $Setup.ValidationRuleControl__c.Skip__c=null , ExpectedLiveDate__c=null
20:31:55.568 (6568923000)|VALIDATION_FAIL
[...]
20:31:55.574 (6574533000)|USER_DEBUG|[166]|DEBUG|FIELD_CUSTOM_VALIDATION_EXCEPTION - Please enter an Expected Live Date

It looks like I don't set the custom setting in the right way.
Why is ValidationRuleControl__c.Skip__c null?

I set ValidationRuleControl__c.Skip__c, then call Database.update(), which causes the beforeUpdate trigger to fire. Then the custom validation rules are checked. The strange thing here is that my trigger has finished before the validation rules are checked, so the context is lost. (Which actually fits with the order of execution.) How do I work around that? I don't want to use IsTest(SeeAllData=true).

Edit: Here is the test method as requested:

public static void setupCustomSettings() {
    [...]
    //Set up Validation Rule Control as default (false)
    ValidationRuleControl__c tempValidationRuleControl = new ValidationRuleControl__c();
    tempValidationRuleControl.Skip__c = false;
    insert tempValidationRuleControl;
}

//checks that the opportunity stage is changed to "Onboarding Started" when the current account status is set to onboarding
//also checks that this works even if the expected live date is missing
static testMethod void testOpportunityUpdatingForOnboarding() {
TriggerHelper.setupCustomSettings();

//create a merchant account
Account merchant = new Account(RecordTypeId = TriggerHelper.getRecordTypeId(Account.SObjectType, TriggerHelper.rtName.Merchant),
                                Name = 'Test Merchant',
                                CurrentAccountStatus__c = Label.CurrentAccountStatus_New,
                                ShippingCountryCode = 'AT',
                                SubChannel__c = 'Skill Games');
insert merchant;

//create an oportunity
Opportunity opp = new Opportunity(AccountId = merchant.Id,
                                  RecordTypeId = TriggerHelper.getRecordTypeId(Opportunity.SObjectType, TriggerHelper.rtName.Opportunity_new),
                                  Topic__c = Label.OpportunityTopic_FirstContract,
                                  StageName = Label.OpportunityStage_New,
                                  Priority__c = Label.OpportunityPriority_Medium,
                                  Name = 'Test Merchant',
                                  CloseDate = Date.today() //mandatory field
                                  //works without expected live date because the validation rule is skipped 
                                  //see the custom setting ValidationRuleControl__c
                                  //ExpectedLiveDate__c = Date.today() + 1 
                                  ); 
insert opp;

//start onboarding
Test.startTest();
merchant.CurrentAccountStatus__c = Label.CurrentAccountStatus_Onboarding;
update merchant;
Test.stopTest();

//check that the opportunity stage has changed
opp = [select Id, StageName from Opportunity where Id = :opp.Id];
System.assertEquals(Label.OpportunityStage_OnboardingStarted, opp.StageName);
}

Best Answer

I'm using the same pattern, successfully switching off validations when building complex data structures within unit tests. Your case intrigued even more, as your code looks absolutely correct. After a bit of investigation I've come to the conclusion that Salesforce debug log misleadingly displays values of Custom Settings set within unit tests as NULLs.

In other words, in your unit test, while evaluating the Validation Rule's condition, $Setup.ValidationRuleControl__c.Skip__c has in fact value false. You can easily test it by amending the unit test to set Skip__c to true - the validation rule should not stop the update.

Related Solutions

[SalesForce] Make Validation Rule bypass if TRIGGER is run

Use a hierarchical custom setting.

The setting just has two fields.

Location -> Lookup to user/profile
Skip_Validation__c -> Set it to true to skip validation.

Update your validation rules to not fire when Skip validation = true for the custom setting.

&& NOT($Setup.MyCustomSetting__c.Skip_Validation__c)

As the last step, your trigger shuts off validation at the start and enables it at the end.

MyCustomSetting__c tempSkipValidation = 
  MyCustomSetting__c.getInstance();

if(tempSkipValidation == null) {
  tempSkipValidation = new MyCustomSetting__c();
}

tempSkipValidation.Skip_Validation__c = true;
upsert tempSkipValidation;

//WHATEVER TRIGGER NORMALLY DOES HERE

tempSkipValidation.Skip_Validation__c = false;
update tempSkipValidation;

[SalesForce] Unit Test is Providing 0% Coverage for Apex Trigger

The trigger code is having lot of redundancy, So I modified it. before posting the modified code few lines of explanation what I changed. you collected account Ids twice and did the condition check twice where once is more enough. I am also made changes to the test class, where Task data is provided which is not required because the trigger has to create it once the necessary conditions are met. I am expecting this trigger should work for you, if there is any errors feel free to post as a comment.

trigger OpportunityAfter on Opportunity (after update){

    Set AccountIDs = new Set();

    for(Opportunity o : trigger.new){
        if(opp.StageName == 'Closed - Lost' && opp.Business_Line__c == 'Workforce' && 
            opp.Survey_Type__c != 'APulse' && trigger.oldMap.get(opp.Id).StageName != opp.StageName){

                AccountIDs.add(o.AccountId);
         }
    }

    Task[] tasksToInsert = new Task[]{};

    for (Account acc : [Select Id, Name, OwnerId from Account where Id IN :AccountIds]){
        for (Opportunity opp : trigger.new){
            if(opp.AccountId == acc.Id){
                Task tas = new Task();
                tas.WhatId=acc.Id;
                tas.OwnerId=opp.OwnerId;
                tas.Subject='Follow-up: ' + opp.name + ' - ' + acc.name;
                tas.ActivityDate=(opp.CloseDate + 180);
                tas.Description='Follow up to see how engagement initiatives are going and if Avatar can help. Refer to lost opportunity: ' + opp.name;
                tasksToInsert.add(tas);                                                         
            }
        }
    }
    if(tasksToInsert != null && !tasksToInsert.isEmpty())
    Database.insert(tasksToInsert);

}

@isTest
public class TestClass {

    static testMethod void myUnitTest() {

    //Set up user
    User u1 = [SELECT Id FROM User WHERE Email='abc@sampleemail.com'];
    test.startTest();  
    //Run As U1
    System.RunAs(u1){

    System.debug('Testing trigger... (single record validation)');

    //NEW Account record
    Account acc = new account();
    acc.Name = 'Test Account';
    acc.Industry = 'Healthcare';

    insert acc;

    //NEW Opportunity record
    Opportunity opp = new Opportunity();
    opp.Name = 'Test Opportunity'; 
    opp.CloseDate = System.today();
    opp.StageName = 'S1 - Investigative';
    opp.Type = 'Repeat Business - Wrkforce HC';
    opp.AccountId = acc.Id;
    opp.Survey_Type__c = 'Product Name';

    insert opp;

    opp.StageName = 'Closed - Lost';
    opp.Reason_Won_Lost__c = 'Relationship';
    opp.Business_Line__c = 'Workforce'  //added this line to meet the if condition while collecting the set of id in the trigger.

    update opp;
   test.stopTest();
    // Here I am expecting the task has been inserted and doing a query for it         and check it in the assert statement.
   Task  testTask=[Select Id, WhatId from Task where WhatId=:acc.Id];
    //Validate single insert
    System.assertEquals(acc.Id, testTask.WhatId);

    }
    }
}

Best Answer

Related Solutions

[SalesForce] Make Validation Rule bypass if TRIGGER is run

[SalesForce] Unit Test is Providing 0% Coverage for Apex Trigger

Related Topic