How do you clear the ApexPages.getMessages() collection in a test?





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ margin-bottom:0;
}







10















The longtime frustration of not being able to clear the messages in tests is marked as a delivered idea in Summer '18 here Add support for clearing PageMessages via Apex.



A failing of that forum is that there never seems to be a link to what was actually done, leaving you back in Google land trying to figure out what that was. In this case I haven't found any new methods in the documentation, and can confirm that the second assert here fails using API 45:



    System.assert(ApexPages.getMessages().size() > 0);
ApexPages.getMessages().clear();
System.assert(ApexPages.getMessages().size() == 0);


So how are the messages cleared?










share|improve this question





























    10















    The longtime frustration of not being able to clear the messages in tests is marked as a delivered idea in Summer '18 here Add support for clearing PageMessages via Apex.



    A failing of that forum is that there never seems to be a link to what was actually done, leaving you back in Google land trying to figure out what that was. In this case I haven't found any new methods in the documentation, and can confirm that the second assert here fails using API 45:



        System.assert(ApexPages.getMessages().size() > 0);
    ApexPages.getMessages().clear();
    System.assert(ApexPages.getMessages().size() == 0);


    So how are the messages cleared?










    share|improve this question

























      10












      10








      10








      The longtime frustration of not being able to clear the messages in tests is marked as a delivered idea in Summer '18 here Add support for clearing PageMessages via Apex.



      A failing of that forum is that there never seems to be a link to what was actually done, leaving you back in Google land trying to figure out what that was. In this case I haven't found any new methods in the documentation, and can confirm that the second assert here fails using API 45:



          System.assert(ApexPages.getMessages().size() > 0);
      ApexPages.getMessages().clear();
      System.assert(ApexPages.getMessages().size() == 0);


      So how are the messages cleared?










      share|improve this question














      The longtime frustration of not being able to clear the messages in tests is marked as a delivered idea in Summer '18 here Add support for clearing PageMessages via Apex.



      A failing of that forum is that there never seems to be a link to what was actually done, leaving you back in Google land trying to figure out what that was. In this case I haven't found any new methods in the documentation, and can confirm that the second assert here fails using API 45:



          System.assert(ApexPages.getMessages().size() > 0);
      ApexPages.getMessages().clear();
      System.assert(ApexPages.getMessages().size() == 0);


      So how are the messages cleared?







      apex visualforce pagemessages






      share|improve this question













      share|improve this question











      share|improve this question




      share|improve this question










      asked Apr 14 at 21:02









      Keith CKeith C

      97k1197220




      97k1197220






















          2 Answers
          2






          active

          oldest

          votes


















          10














          It was easy enough to find the Release Note for this feature by looking at Development > Apex.




          Clear Messages on Visualforce Pages While Testing



          Use the new System.Test.clearApexPageMessages() method to clear the messages on a Visualforce page while executing Apex test methods.



          Where: This change applies to Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions.



          Why: You can use the System.Test.clearApexPageMessages() method to test the success or failure of each call to controller methods. Using this function along with the ApexPages.hasMessages() and ApexPages.getMessages() methods allows you to test Visualforce controllers more easily.




          This method is also included in the documentation on the Test Class:




          clearApexPageMessages()

          Clear the messages on a Visualforce page while executing Apex test methods.



          Signature

          public static void clearApexPageMessages()



          Return Value

          Type: void



          Usage

          This method may only be used in tests.



          Example



          @isTest
          static void clearMessagesTest() {
          Test.setCurrentPage(new PageReference('/'));
          ApexPages.addMessage(
          new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning')
          );
          System.assertEquals(1, ApexPages.getMessages().size());
          Test.clearApexPageMessages();
          System.assertEquals(0, ApexPages.getMessages().size());
          }






          share|improve this answer
























          • Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

            – Keith C
            Apr 14 at 21:14








          • 2





            True true. But now anyone who googles it will need only two minutes thanks to the SE network.

            – Adrian Larson
            Apr 14 at 23:25



















          5














          OK, with a different set of keywords I hit this Clear Messages on Visualforce Pages While Testing release note that talks about the Test.clearApexPageMessages() method. That is explained in the Test Class documentation.



          And happy days, both these assertions pass:



              System.assert(ApexPages.getMessages().size() > 0);
          Test.clearApexPageMessages();
          System.assert(ApexPages.getMessages().size() == 0);





          share|improve this answer
























            Your Answer








            StackExchange.ready(function() {
            var channelOptions = {
            tags: "".split(" "),
            id: "459"
            };
            initTagRenderer("".split(" "), "".split(" "), channelOptions);

            StackExchange.using("externalEditor", function() {
            // Have to fire editor after snippets, if snippets enabled
            if (StackExchange.settings.snippets.snippetsEnabled) {
            StackExchange.using("snippets", function() {
            createEditor();
            });
            }
            else {
            createEditor();
            }
            });

            function createEditor() {
            StackExchange.prepareEditor({
            heartbeatType: 'answer',
            autoActivateHeartbeat: false,
            convertImagesToLinks: false,
            noModals: true,
            showLowRepImageUploadWarning: true,
            reputationToPostImages: null,
            bindNavPrevention: true,
            postfix: "",
            imageUploader: {
            brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
            contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
            allowUrls: true
            },
            onDemand: true,
            discardSelector: ".discard-answer"
            ,immediatelyShowMarkdownHelp:true
            });


            }
            });














            draft saved

            draft discarded


















            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fsalesforce.stackexchange.com%2fquestions%2f257811%2fhow-do-you-clear-the-apexpages-getmessages-collection-in-a-test%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown

























            2 Answers
            2






            active

            oldest

            votes








            2 Answers
            2






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes









            10














            It was easy enough to find the Release Note for this feature by looking at Development > Apex.




            Clear Messages on Visualforce Pages While Testing



            Use the new System.Test.clearApexPageMessages() method to clear the messages on a Visualforce page while executing Apex test methods.



            Where: This change applies to Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions.



            Why: You can use the System.Test.clearApexPageMessages() method to test the success or failure of each call to controller methods. Using this function along with the ApexPages.hasMessages() and ApexPages.getMessages() methods allows you to test Visualforce controllers more easily.




            This method is also included in the documentation on the Test Class:




            clearApexPageMessages()

            Clear the messages on a Visualforce page while executing Apex test methods.



            Signature

            public static void clearApexPageMessages()



            Return Value

            Type: void



            Usage

            This method may only be used in tests.



            Example



            @isTest
            static void clearMessagesTest() {
            Test.setCurrentPage(new PageReference('/'));
            ApexPages.addMessage(
            new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning')
            );
            System.assertEquals(1, ApexPages.getMessages().size());
            Test.clearApexPageMessages();
            System.assertEquals(0, ApexPages.getMessages().size());
            }






            share|improve this answer
























            • Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

              – Keith C
              Apr 14 at 21:14








            • 2





              True true. But now anyone who googles it will need only two minutes thanks to the SE network.

              – Adrian Larson
              Apr 14 at 23:25
















            10














            It was easy enough to find the Release Note for this feature by looking at Development > Apex.




            Clear Messages on Visualforce Pages While Testing



            Use the new System.Test.clearApexPageMessages() method to clear the messages on a Visualforce page while executing Apex test methods.



            Where: This change applies to Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions.



            Why: You can use the System.Test.clearApexPageMessages() method to test the success or failure of each call to controller methods. Using this function along with the ApexPages.hasMessages() and ApexPages.getMessages() methods allows you to test Visualforce controllers more easily.




            This method is also included in the documentation on the Test Class:




            clearApexPageMessages()

            Clear the messages on a Visualforce page while executing Apex test methods.



            Signature

            public static void clearApexPageMessages()



            Return Value

            Type: void



            Usage

            This method may only be used in tests.



            Example



            @isTest
            static void clearMessagesTest() {
            Test.setCurrentPage(new PageReference('/'));
            ApexPages.addMessage(
            new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning')
            );
            System.assertEquals(1, ApexPages.getMessages().size());
            Test.clearApexPageMessages();
            System.assertEquals(0, ApexPages.getMessages().size());
            }






            share|improve this answer
























            • Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

              – Keith C
              Apr 14 at 21:14








            • 2





              True true. But now anyone who googles it will need only two minutes thanks to the SE network.

              – Adrian Larson
              Apr 14 at 23:25














            10












            10








            10







            It was easy enough to find the Release Note for this feature by looking at Development > Apex.




            Clear Messages on Visualforce Pages While Testing



            Use the new System.Test.clearApexPageMessages() method to clear the messages on a Visualforce page while executing Apex test methods.



            Where: This change applies to Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions.



            Why: You can use the System.Test.clearApexPageMessages() method to test the success or failure of each call to controller methods. Using this function along with the ApexPages.hasMessages() and ApexPages.getMessages() methods allows you to test Visualforce controllers more easily.




            This method is also included in the documentation on the Test Class:




            clearApexPageMessages()

            Clear the messages on a Visualforce page while executing Apex test methods.



            Signature

            public static void clearApexPageMessages()



            Return Value

            Type: void



            Usage

            This method may only be used in tests.



            Example



            @isTest
            static void clearMessagesTest() {
            Test.setCurrentPage(new PageReference('/'));
            ApexPages.addMessage(
            new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning')
            );
            System.assertEquals(1, ApexPages.getMessages().size());
            Test.clearApexPageMessages();
            System.assertEquals(0, ApexPages.getMessages().size());
            }






            share|improve this answer













            It was easy enough to find the Release Note for this feature by looking at Development > Apex.




            Clear Messages on Visualforce Pages While Testing



            Use the new System.Test.clearApexPageMessages() method to clear the messages on a Visualforce page while executing Apex test methods.



            Where: This change applies to Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions.



            Why: You can use the System.Test.clearApexPageMessages() method to test the success or failure of each call to controller methods. Using this function along with the ApexPages.hasMessages() and ApexPages.getMessages() methods allows you to test Visualforce controllers more easily.




            This method is also included in the documentation on the Test Class:




            clearApexPageMessages()

            Clear the messages on a Visualforce page while executing Apex test methods.



            Signature

            public static void clearApexPageMessages()



            Return Value

            Type: void



            Usage

            This method may only be used in tests.



            Example



            @isTest
            static void clearMessagesTest() {
            Test.setCurrentPage(new PageReference('/'));
            ApexPages.addMessage(
            new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning')
            );
            System.assertEquals(1, ApexPages.getMessages().size());
            Test.clearApexPageMessages();
            System.assertEquals(0, ApexPages.getMessages().size());
            }







            share|improve this answer












            share|improve this answer



            share|improve this answer










            answered Apr 14 at 21:07









            Adrian LarsonAdrian Larson

            110k19121259




            110k19121259













            • Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

              – Keith C
              Apr 14 at 21:14








            • 2





              True true. But now anyone who googles it will need only two minutes thanks to the SE network.

              – Adrian Larson
              Apr 14 at 23:25



















            • Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

              – Keith C
              Apr 14 at 21:14








            • 2





              True true. But now anyone who googles it will need only two minutes thanks to the SE network.

              – Adrian Larson
              Apr 14 at 23:25

















            Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

            – Keith C
            Apr 14 at 21:14







            Would be easier still if a link was put back in the idea once the feature was documented in the normal product help. Would have saved 15 wasted minutes of my life and 5 of yours.

            – Keith C
            Apr 14 at 21:14






            2




            2





            True true. But now anyone who googles it will need only two minutes thanks to the SE network.

            – Adrian Larson
            Apr 14 at 23:25





            True true. But now anyone who googles it will need only two minutes thanks to the SE network.

            – Adrian Larson
            Apr 14 at 23:25













            5














            OK, with a different set of keywords I hit this Clear Messages on Visualforce Pages While Testing release note that talks about the Test.clearApexPageMessages() method. That is explained in the Test Class documentation.



            And happy days, both these assertions pass:



                System.assert(ApexPages.getMessages().size() > 0);
            Test.clearApexPageMessages();
            System.assert(ApexPages.getMessages().size() == 0);





            share|improve this answer




























              5














              OK, with a different set of keywords I hit this Clear Messages on Visualforce Pages While Testing release note that talks about the Test.clearApexPageMessages() method. That is explained in the Test Class documentation.



              And happy days, both these assertions pass:



                  System.assert(ApexPages.getMessages().size() > 0);
              Test.clearApexPageMessages();
              System.assert(ApexPages.getMessages().size() == 0);





              share|improve this answer


























                5












                5








                5







                OK, with a different set of keywords I hit this Clear Messages on Visualforce Pages While Testing release note that talks about the Test.clearApexPageMessages() method. That is explained in the Test Class documentation.



                And happy days, both these assertions pass:



                    System.assert(ApexPages.getMessages().size() > 0);
                Test.clearApexPageMessages();
                System.assert(ApexPages.getMessages().size() == 0);





                share|improve this answer













                OK, with a different set of keywords I hit this Clear Messages on Visualforce Pages While Testing release note that talks about the Test.clearApexPageMessages() method. That is explained in the Test Class documentation.



                And happy days, both these assertions pass:



                    System.assert(ApexPages.getMessages().size() > 0);
                Test.clearApexPageMessages();
                System.assert(ApexPages.getMessages().size() == 0);






                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Apr 14 at 21:06









                Keith CKeith C

                97k1197220




                97k1197220






























                    draft saved

                    draft discarded




















































                    Thanks for contributing an answer to Salesforce Stack Exchange!


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid



                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.


                    To learn more, see our tips on writing great answers.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function () {
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fsalesforce.stackexchange.com%2fquestions%2f257811%2fhow-do-you-clear-the-apexpages-getmessages-collection-in-a-test%23new-answer', 'question_page');
                    }
                    );

                    Post as a guest















                    Required, but never shown





















































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown

































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown







                    Popular posts from this blog

                    Plaza Victoria

                    In PowerPoint, is there a keyboard shortcut for bulleted / numbered list?

                    How to put 3 figures in Latex with 2 figures side by side and 1 below these side by side images but in...