185 строки
14 KiB
YAML
185 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.test.TestContextManager"
|
|
fullName: "com.azure.core.test.TestContextManager"
|
|
name: "TestContextManager"
|
|
nameWithType: "TestContextManager"
|
|
summary: "This class handles managing context about a test, such as custom testing annotations and verifying whether the test is capable of running."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **TestContextManager**"
|
|
constructors:
|
|
- uid: "com.azure.core.test.TestContextManager.TestContextManager(java.lang.reflect.Method,com.azure.core.test.TestMode)"
|
|
fullName: "com.azure.core.test.TestContextManager.TestContextManager(Method testMethod, TestMode testMode)"
|
|
name: "TestContextManager(Method testMethod, TestMode testMode)"
|
|
nameWithType: "TestContextManager.TestContextManager(Method testMethod, TestMode testMode)"
|
|
summary: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
parameters:
|
|
- description: "Test method being ran."
|
|
name: "testMethod"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html\">Method</a>"
|
|
- description: "The <xref uid=\"com.azure.core.test.TestMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestMode\"></xref> the test is running in."
|
|
name: "testMode"
|
|
type: "<xref href=\"com.azure.core.test.TestMode?alt=com.azure.core.test.TestMode&text=TestMode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public TestContextManager(Method testMethod, TestMode testMode)"
|
|
desc: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
- uid: "com.azure.core.test.TestContextManager.TestContextManager(java.lang.reflect.Method,com.azure.core.test.TestMode,boolean,boolean,java.nio.file.Path)"
|
|
fullName: "com.azure.core.test.TestContextManager.TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath)"
|
|
name: "TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath)"
|
|
nameWithType: "TestContextManager.TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath)"
|
|
summary: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
parameters:
|
|
- description: "Test method being ran."
|
|
name: "testMethod"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html\">Method</a>"
|
|
- description: "The <xref uid=\"com.azure.core.test.TestMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestMode\"></xref> the test is running in."
|
|
name: "testMode"
|
|
type: "<xref href=\"com.azure.core.test.TestMode?alt=com.azure.core.test.TestMode&text=TestMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "True if the external test proxy is in use."
|
|
name: "enableTestProxy"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "flag indicating if <code>RecordWithoutRequestBody</code> annotation\n present on test class."
|
|
name: "recordWithoutRequestBodyClassAnnotation"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the test class path"
|
|
name: "testClassPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html\">Path</a>"
|
|
syntax: "public TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath)"
|
|
desc: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
- uid: "com.azure.core.test.TestContextManager.TestContextManager(java.lang.reflect.Method,com.azure.core.test.TestMode,boolean,boolean,java.nio.file.Path,java.lang.String)"
|
|
fullName: "com.azure.core.test.TestContextManager.TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath, String trackerTestName)"
|
|
name: "TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath, String trackerTestName)"
|
|
nameWithType: "TestContextManager.TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath, String trackerTestName)"
|
|
summary: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
parameters:
|
|
- description: "Test method being ran."
|
|
name: "testMethod"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html\">Method</a>"
|
|
- description: "The <xref uid=\"com.azure.core.test.TestMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestMode\"></xref> the test is running in."
|
|
name: "testMode"
|
|
type: "<xref href=\"com.azure.core.test.TestMode?alt=com.azure.core.test.TestMode&text=TestMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "True if the external test proxy is in use."
|
|
name: "enableTestProxy"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "flag indicating if <code>RecordWithoutRequestBody</code> annotation\n present on test class."
|
|
name: "recordWithoutRequestBodyClassAnnotation"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the test class path"
|
|
name: "testClassPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html\">Path</a>"
|
|
- description: "The formatted test name used in logging and tracking its progress."
|
|
name: "trackerTestName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TestContextManager(Method testMethod, TestMode testMode, boolean enableTestProxy, boolean recordWithoutRequestBodyClassAnnotation, Path testClassPath, String trackerTestName)"
|
|
desc: "Constructs a <xref uid=\"com.azure.core.test.TestContextManager\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestContextManager\"></xref> based on the test method."
|
|
methods:
|
|
- uid: "com.azure.core.test.TestContextManager.didTestRun()"
|
|
fullName: "com.azure.core.test.TestContextManager.didTestRun()"
|
|
name: "didTestRun()"
|
|
nameWithType: "TestContextManager.didTestRun()"
|
|
summary: "Returns whether the current test was ran."
|
|
syntax: "public boolean didTestRun()"
|
|
desc: "Returns whether the current test was ran."
|
|
returns:
|
|
description: "Flag indicating whether the current test was ran."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.test.TestContextManager.doNotRecordTest()"
|
|
fullName: "com.azure.core.test.TestContextManager.doNotRecordTest()"
|
|
name: "doNotRecordTest()"
|
|
nameWithType: "TestContextManager.doNotRecordTest()"
|
|
summary: "Returns whether the test should have its network calls recorded during a <xref uid=\"com.azure.core.test.TestMode.RECORD\" data-throw-if-not-resolved=\"false\" data-raw-source=\"record\"></xref> test run."
|
|
syntax: "public boolean doNotRecordTest()"
|
|
desc: "Returns whether the test should have its network calls recorded during a <xref uid=\"com.azure.core.test.TestMode.RECORD\" data-throw-if-not-resolved=\"false\" data-raw-source=\"record\"></xref> test run."
|
|
returns:
|
|
description: "Flag indicating whether to record test network calls."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.test.TestContextManager.getTestMode()"
|
|
fullName: "com.azure.core.test.TestContextManager.getTestMode()"
|
|
name: "getTestMode()"
|
|
nameWithType: "TestContextManager.getTestMode()"
|
|
summary: "Returns the mode being used to run tests."
|
|
syntax: "public TestMode getTestMode()"
|
|
desc: "Returns the mode being used to run tests."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.core.test.TestMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestMode\"></xref> being used to run tests."
|
|
type: "<xref href=\"com.azure.core.test.TestMode?alt=com.azure.core.test.TestMode&text=TestMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.test.TestContextManager.getTestName()"
|
|
fullName: "com.azure.core.test.TestContextManager.getTestName()"
|
|
name: "getTestName()"
|
|
nameWithType: "TestContextManager.getTestName()"
|
|
summary: "Returns the name of the test being ran."
|
|
syntax: "public String getTestName()"
|
|
desc: "Returns the name of the test being ran."
|
|
returns:
|
|
description: "The test name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.core.test.TestContextManager.getTestPlaybackRecordingName()"
|
|
fullName: "com.azure.core.test.TestContextManager.getTestPlaybackRecordingName()"
|
|
name: "getTestPlaybackRecordingName()"
|
|
nameWithType: "TestContextManager.getTestPlaybackRecordingName()"
|
|
summary: "Returns the name of the playback record for the test being ran."
|
|
syntax: "public String getTestPlaybackRecordingName()"
|
|
desc: "Returns the name of the playback record for the test being ran."
|
|
returns:
|
|
description: "The playback record name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.core.test.TestContextManager.getTrackerTestName()"
|
|
fullName: "com.azure.core.test.TestContextManager.getTrackerTestName()"
|
|
name: "getTrackerTestName()"
|
|
nameWithType: "TestContextManager.getTrackerTestName()"
|
|
summary: "Gets the formatted name of the test used to log and track its progress."
|
|
syntax: "public String getTrackerTestName()"
|
|
desc: "Gets the formatted name of the test used to log and track its progress."
|
|
returns:
|
|
description: "The formatted test name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.core.test.TestContextManager.isTestProxyEnabled()"
|
|
fullName: "com.azure.core.test.TestContextManager.isTestProxyEnabled()"
|
|
name: "isTestProxyEnabled()"
|
|
nameWithType: "TestContextManager.isTestProxyEnabled()"
|
|
summary: "Returns if the test proxy is enabled"
|
|
syntax: "public boolean isTestProxyEnabled()"
|
|
desc: "Returns if the test proxy is enabled"
|
|
returns:
|
|
description: "True if the text proxy is enabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.test.TestContextManager.setTestIteration(java.lang.Integer)"
|
|
fullName: "com.azure.core.test.TestContextManager.setTestIteration(Integer testIteration)"
|
|
name: "setTestIteration(Integer testIteration)"
|
|
nameWithType: "TestContextManager.setTestIteration(Integer testIteration)"
|
|
summary: "Sets the test iteration for parameterized tests."
|
|
parameters:
|
|
- description: "Test iteration."
|
|
name: "testIteration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public void setTestIteration(Integer testIteration)"
|
|
desc: "Sets the test iteration for parameterized tests."
|
|
- uid: "com.azure.core.test.TestContextManager.skipRecordingRequestBody()"
|
|
fullName: "com.azure.core.test.TestContextManager.skipRecordingRequestBody()"
|
|
name: "skipRecordingRequestBody()"
|
|
nameWithType: "TestContextManager.skipRecordingRequestBody()"
|
|
summary: "Returns whether the test is recording request body when run <xref uid=\"com.azure.core.test.TestMode.RECORD\" data-throw-if-not-resolved=\"false\" data-raw-source=\"record\"></xref> mode."
|
|
syntax: "public boolean skipRecordingRequestBody()"
|
|
desc: "Returns whether the test is recording request body when run <xref uid=\"com.azure.core.test.TestMode.RECORD\" data-throw-if-not-resolved=\"false\" data-raw-source=\"record\"></xref> mode."
|
|
returns:
|
|
description: "Flag indicating whether test should record request bodies."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "This class handles managing context about a test, such as custom testing annotations and verifying whether the test is capable of running."
|
|
metadata: {}
|
|
package: "com.azure.core.test"
|
|
artifact: com.azure:azure-core-test:1.26.2
|