1 /*
2  * Copyright (C) 2024 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.adservices.shared.testing;
18 
19 import static java.lang.annotation.ElementType.METHOD;
20 import static java.lang.annotation.ElementType.TYPE;
21 import static java.lang.annotation.RetentionPolicy.RUNTIME;
22 
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.Target;
25 
26 /**
27  * Annotation used to skip logging usage rule. Use at class level to skip all tests; user at method
28  * level to skip individual tests. Reason for usage must be provided.
29  *
30  * <p>NOTE: If this annotation is used, ErrorLogUtil invocation mocking does not come for "free" as
31  * the rule is deactivated for the test method(s); mocking will need to be done explicitly.
32  */
33 @Retention(RUNTIME)
34 @Target({METHOD, TYPE})
35 public @interface SkipLoggingUsageRule {
36     /** Reason why the test should be skipped. */
reason()37     String reason();
38 }
39