aboutsummaryrefslogtreecommitdiff
path: root/eclipse/plugins/com.android.ide.eclipse.tests/src/com/android/ide/eclipse/adt/internal/lint/ProjectLintConfigurationTest.java
blob: f8ea8c43577e9dc307d7654b832620de28ef426f (plain)
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * Copyright (C) 2011 The Android Open Source Project
 *
 * Licensed under the Eclipse Public License, Version 1.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.eclipse.org/org/documents/epl-v10.php
 *
 * 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.ide.eclipse.adt.internal.lint;

import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.ide.eclipse.adt.internal.editors.layout.refactoring.AdtProjectTest;
import com.android.tools.lint.checks.DuplicateIdDetector;
import com.android.tools.lint.checks.UnusedResourceDetector;
import com.android.tools.lint.client.api.Configuration;
import com.android.tools.lint.client.api.JavaParser;
import com.android.tools.lint.client.api.LintClient;
import com.android.tools.lint.client.api.XmlParser;
import com.android.tools.lint.detector.api.Context;
import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.Location;
import com.android.tools.lint.detector.api.Project;
import com.android.tools.lint.detector.api.Severity;
import com.android.tools.lint.detector.api.TextFormat;

import org.eclipse.core.resources.IProject;

import java.io.File;

@SuppressWarnings("javadoc")
public class ProjectLintConfigurationTest extends AdtProjectTest {
    public void testBasic() {
        Configuration parent = null;
        LintClient client = new TestClient();

        File dir = getTargetDir();
        if (!dir.exists()) {
            boolean ok = dir.mkdirs();
            assertTrue(dir.getPath(), ok);
        }
        Project project = client.getProject(dir, dir);

        ProjectLintConfiguration config =
                new ProjectLintConfiguration(client, project, parent, false /*fatalOnly*/);

        Issue usuallyEnabledIssue = DuplicateIdDetector.WITHIN_LAYOUT;
        Issue usuallyDisabledIssue = UnusedResourceDetector.ISSUE_IDS;

        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        config.setSeverity(usuallyEnabledIssue, Severity.IGNORE);
        config.setSeverity(usuallyDisabledIssue, Severity.ERROR);
        assertFalse(config.isEnabled(usuallyEnabledIssue));
        assertTrue(config.isEnabled(usuallyDisabledIssue));

        // Make a NEW config object to ensure the state is persisted properly, not just
        // kept on the config object!
        config = new ProjectLintConfiguration(client, project, parent, false /*fatalOnly*/);
        assertFalse(config.isEnabled(usuallyEnabledIssue));
        assertTrue(config.isEnabled(usuallyDisabledIssue));
    }

    public void testInheritance() {
        Configuration parent = null;
        LintClient client = new TestClient();

        File dir = getTargetDir();
        assertTrue(dir.mkdirs());
        Project project = client.getProject(dir, dir);

        File otherDir = new File(dir, "otherConfig");
        assertTrue(otherDir.mkdir());
        Project otherProject = client.getProject(otherDir, otherDir);

        ProjectLintConfiguration otherConfig =
                new ProjectLintConfiguration(client, otherProject, parent, false);

        ProjectLintConfiguration config =
                new ProjectLintConfiguration(client, project, otherConfig, false);

        Issue usuallyEnabledIssue = DuplicateIdDetector.WITHIN_LAYOUT;
        Issue usuallyDisabledIssue = UnusedResourceDetector.ISSUE_IDS;

        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        otherConfig.setSeverity(usuallyEnabledIssue, Severity.IGNORE);
        otherConfig.setSeverity(usuallyDisabledIssue, Severity.ERROR);

        // Ensure inheritance works
        assertFalse(config.isEnabled(usuallyEnabledIssue));
        assertTrue(config.isEnabled(usuallyDisabledIssue));

        // Revert
        otherConfig.setSeverity(usuallyEnabledIssue, Severity.ERROR);
        otherConfig.setSeverity(usuallyDisabledIssue, Severity.IGNORE);
        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        // Now override in child
        config.setSeverity(usuallyEnabledIssue, Severity.ERROR);
        config.setSeverity(usuallyDisabledIssue, Severity.IGNORE);
        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        // Now change in parent: no change in child
        otherConfig.setSeverity(usuallyEnabledIssue, Severity.IGNORE);
        otherConfig.setSeverity(usuallyDisabledIssue, Severity.ERROR);
        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));
        assertFalse(otherConfig.isEnabled(usuallyEnabledIssue));
        assertTrue(otherConfig.isEnabled(usuallyDisabledIssue));

        // Clear override in child
        config.setSeverity(usuallyEnabledIssue, null);
        config.setSeverity(usuallyDisabledIssue, null);
        assertFalse(config.isEnabled(usuallyEnabledIssue));
        assertTrue(config.isEnabled(usuallyDisabledIssue));
    }

    public void testBulkEditing() {
        Configuration parent = null;
        LintClient client = new TestClient();

        File dir = getTargetDir();
        assertTrue(dir.mkdirs());
        Project project = client.getProject(dir, dir);

        ProjectLintConfiguration config =
                new ProjectLintConfiguration(client, project, parent, false /*fatalOnly*/);

        Issue usuallyEnabledIssue = DuplicateIdDetector.WITHIN_LAYOUT;
        Issue usuallyDisabledIssue = UnusedResourceDetector.ISSUE_IDS;

        assertTrue(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        config.setSeverity(usuallyEnabledIssue, Severity.IGNORE);
        assertFalse(config.isEnabled(usuallyEnabledIssue));
        assertFalse(config.isEnabled(usuallyDisabledIssue));

        File configFile = new File(dir, "lint.xml");
        assertTrue(configFile.getPath(), configFile.exists());
        long lastModified = configFile.lastModified();

        // We need to make sure that the timestamp of the file is a couple of seconds
        // after the last update or we can't tell whether the file was updated or not

        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            System.err.println("Sleep interrupted, test may not work.");
        }
        config.startBulkEditing();
        assertFalse(lastModified < configFile.lastModified());
        assertEquals(lastModified, configFile.lastModified());
        config.setSeverity(usuallyDisabledIssue, Severity.ERROR);
        config.finishBulkEditing();
        assertTrue(lastModified < configFile.lastModified());

        assertTrue(config.isEnabled(usuallyDisabledIssue));
    }

    public void testPersistence() {
        // Ensure that we use the same configuration object repeatedly for a
        // single project, such that we don't recompute and parse XML for each and
        // every lint run!
        IProject project = getProject();
        TestClient client = new TestClient();
        ProjectLintConfiguration config1 = ProjectLintConfiguration.get(client, project, false);
        ProjectLintConfiguration config2 = ProjectLintConfiguration.get(client, project, false);
        assertSame(config1, config2);
    }

    @Override
    protected File getTargetDir() {
        File targetDir = new File(getTempDir(), getClass().getSimpleName() + "_" + getName());
        addCleanupDir(targetDir);
        return targetDir;
    }

    private static class TestClient extends LintClient {
        @Override
        public void report(@NonNull Context context, @NonNull Issue issue,
                @NonNull Severity severity, @Nullable Location location,
                @NonNull String message, @NonNull TextFormat format) {
        }

        @Override
        public void log(@NonNull Severity severity, @Nullable Throwable exception,
                @Nullable String format, @Nullable Object... args) {
        }

        @Override
        public XmlParser getXmlParser() {
            return null;
        }

        @Override
        public @NonNull String readFile(@NonNull File file) {
            return null;
        }

        @Override
        public JavaParser getJavaParser(@Nullable Project project) {
            return null;
        }
    }
}