1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License
*/
package com.android.tv.common.feature;
import android.content.Context;
import android.support.annotation.VisibleForTesting;
import android.util.Log;
import com.android.tv.common.util.CommonUtils;
/**
* When run in a test harness this feature can be turned on or off, overriding the normal value.
*
* <p><b>Warning</b> making a feature testable will cause the code to stay in the APK and could leak
* unreleased features.
*/
public class TestableFeature implements Feature {
private static final String TAG = "TestableFeature";
private static final String DETAIL_MESSAGE =
"TestableFeatures should only be changed in tests.";
private final Feature mDelegate;
private Boolean mTestValue = null;
/** Creates testable feature. */
public static TestableFeature createTestableFeature(Feature delegate) {
return new TestableFeature(delegate);
}
/** Creates testable feature with initial value. */
public static TestableFeature createTestableFeature(Feature delegate, Boolean initialValue) {
return new TestableFeature(delegate, initialValue);
}
private TestableFeature(Feature delegate) {
mDelegate = delegate;
}
private TestableFeature(Feature delegate, Boolean initialValue) {
mDelegate = delegate;
mTestValue = initialValue;
}
@VisibleForTesting
public void enableForTest() {
if (!CommonUtils.isRunningInTest()) {
Log.e(TAG, "Not enabling for test:" + this, new IllegalStateException(DETAIL_MESSAGE));
} else {
mTestValue = true;
}
}
@VisibleForTesting
public void disableForTests() {
if (!CommonUtils.isRunningInTest()) {
Log.e(
TAG,
"Not disabling for test: " + this,
new IllegalStateException(DETAIL_MESSAGE));
} else {
mTestValue = false;
}
}
@VisibleForTesting
public void resetForTests() {
if (!CommonUtils.isRunningInTest()) {
Log.e(TAG, "Not resetting feature: " + this, new IllegalStateException(DETAIL_MESSAGE));
} else {
mTestValue = null;
}
}
@Override
public boolean isEnabled(Context context) {
if (CommonUtils.isRunningInTest() && mTestValue != null) {
return mTestValue;
}
return mDelegate.isEnabled(context);
}
@Override
public String toString() {
String msg = mDelegate.toString();
if (CommonUtils.isRunningInTest()) {
if (mTestValue == null) {
msg = "Testable Feature is unchanged: " + msg;
} else {
msg = "Testable Feature is " + (mTestValue ? "on" : "off") + " was " + msg;
}
}
return msg;
}
}
|
