Apex Developer Guide

Apex Developer Guide
Release Notes
Getting Started with Apex
Writing Apex
Data Types and Variables
Control Flow Statements
Classes, Objects, and Interfaces
Classes
Interfaces
Keywords
Annotations
AuraEnabled Annotation
Deprecated Annotation
Future Annotation
InvocableMethod Annotation
InvocableVariable Annotation
IsTest Annotation
JsonAccess Annotation
NamespaceAccessible Annotation
ReadOnly Annotation
RemoteAction Annotation
SuppressWarnings Annotation
TestSetup Annotation
TestVisible Annotation
Apex REST Annotations
Classes and Casting
Differences Between Apex Classes and Java Classes
Class Definition Creation
Namespace Prefix
Apex Code Versions
Lists of Custom Types and Sorting
Using Custom Types in Map Keys and Sets
Working with Data in Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Reference
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

IsTest Annotation

Use the @IsTest annotation to define classes and methods that only contain code used for testing your application. The annotation can take multiple modifiers within parentheses and separated by blanks.

The @IsTest annotation on methods is equivalent to the testMethod keyword. As best practice, Salesforce recommends that you use @IsTest rather than testMethod. The testMethod keyword may be versioned out in a future release.

Note

Classes and methods defined as @IsTest can be either private or public. Classes defined as @IsTest must be top-level classes.

Classes defined with the @IsTest annotation don't count against your organization limit of 6 MB for all Apex code.

Note

Here’s an example of a private test class that contains two test methods.

Here’s an example of a public test class that contains utility methods for test data creation:

Classes defined as @IsTest can't be interfaces or enums.

Methods of a public test class can only be called from a running test, that is, a test method or code invoked by a test method. Non-test requests can’t call public methods.. To learn about the various ways you can run test methods, see Run Unit Test Methods.

@IsTest(SeeAllData=true) Annotation

For Apex code saved using Salesforce API version 24.0 and later, use the @IsTest(SeeAllData=true) annotation to grant test classes and individual test methods access to all data in the organization. The access includes pre-existing data that the test didn’t create. Starting with Apex code saved using Salesforce API version 24.0, test methods don’t have access to pre-existing data in the organization. However, test code saved against Salesforce API version 23.0 and earlier continues to have access to all data in the organization. See Isolation of Test Data from Organization Data in Unit Tests.

Considerations for the @IsTest(SeeAllData=true) Annotation
  • If a test class is defined with the @IsTest(SeeAllData=true) annotation, the SeeAllData=true applies to all test methods that don’t explicitly set the SeeAllData keyword.
  • The @IsTest(SeeAllData=true) annotation is used to open up data access when applied at the class or method level. However, if the containing class has been annotated with @IsTest(SeeAllData=true), annotating a method with @IsTest(SeeAllData=false) is ignored for that method. In this case, that method still has access to all the data in the organization. Annotating a method with @IsTest(SeeAllData=true) overrides, for that method, an @IsTest(SeeAllData=false) annotation on the class.
  • @IsTest(SeeAllData=true) and @IsTest(IsParallel=true) annotations can’t be used together on the same Apex method.
This example shows how to define a test class with the @IsTest(SeeAllData=true) annotation. All the test methods in this class have access to all data in the organization.
This second example shows how to apply the @IsTest(SeeAllData=true) annotation on a test method. Because the test method’s class isn’t annotated, you have to annotate the method to enable access to all data for the method. The second test method doesn’t have this annotation, so it can access only the data it creates. In addition, it can access objects that are used to manage your organization, such as users.

@IsTest(OnInstall=true) Annotation

Use the @IsTest(OnInstall=true) annotation to specify which Apex tests are executed during package installation. This annotation is used for tests in managed or unmanaged packages. Only test methods with this annotation, or methods that are part of a test class that has this annotation, are executed during package installation. Tests annotated to run during package installation must pass in order for the package installation to succeed. It’s no longer possible to bypass a failing test during package installation. A test method or a class that doesn't have this annotation, or that is annotated with @IsTest(OnInstall=false) or @IsTest, isn’t executed during installation.

Tests annotated with IsTest(OnInstall=true) that run during package install and upgrade aren’t counted towards code coverage. However, code coverage is tracked and counted during a package creation operation. Because Apex code installed from a managed package is excluded from org level requirements for code coverage, it’s unlikely that you’re affected. But, if you track managed package test coverage, you must rerun these tests outside of the package install or upgrade operation for code coverage statistics to be updated. Package install isn’t blocked by code coverage requirements.

This example shows how to annotate a test method that is executed during package installation. In this example, test1 is executed but test2 and test3 isn’t.

@IsTest(IsParallel=true) Annotation

Use the @IsTest(IsParallel=true) annotation to indicate test classes that can run in parallel. Default limits on the number of concurrent tests don’t apply to these test classes. This annotation makes the execution of test classes more efficient, because more tests can be run in parallel.
Considerations for the @IsTest(IsParallel=true) Annotation
  • This annotation overrides settings that disable parallel testing.
  • @IsTest(SeeAllData=true) and @IsTest(IsParallel=true) annotations can’t be used together on the same Apex method.