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
|
# Copyright 2017 The Bazel Authors. All rights reserved.
#
# 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.
import os.path
import shutil
import subprocess
import tempfile
import unittest
from src.test.skylark.skylint import testenv
class SkylintTest(unittest.TestCase):
def testGoodFile(self):
output = subprocess.check_output([
testenv.SKYLINT_BINARY_PATH,
os.path.join(testenv.SKYLINT_TESTDATA_PATH, "good.bzl.test")
])
output = output.decode("utf-8")
self.assertEqual(output, "")
def testBadFile(self):
try:
issues = ""
subprocess.check_output([
testenv.SKYLINT_BINARY_PATH,
os.path.join(testenv.SKYLINT_TESTDATA_PATH, "bad.bzl.test")
])
except subprocess.CalledProcessError as e:
issues = e.output.decode("utf-8")
self.assertIn("no module docstring", issues)
def testNonexistingFile(self):
try:
output = ""
subprocess.check_output(
[testenv.SKYLINT_BINARY_PATH, "does_not_exist.bzl"],
stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as e:
output = e.output.decode("utf-8")
self.assertEqual("File not found: does_not_exist.bzl\n", output)
def testDisablingCheck(self):
output = subprocess.check_output([
testenv.SKYLINT_BINARY_PATH, "--disable-checks=docstring",
os.path.join(testenv.SKYLINT_TESTDATA_PATH, "bad.bzl.test")
])
output = output.decode("utf-8")
self.assertEqual(output, "")
def testDisablingCategory(self):
output = subprocess.check_output([
testenv.SKYLINT_BINARY_PATH,
"--disable-categories=missing-module-docstring",
os.path.join(testenv.SKYLINT_TESTDATA_PATH, "bad.bzl.test")
])
output = output.decode("utf-8")
self.assertEqual(output, "")
IMPORT_BZL_CONTENTS = """
def foo():
'''bar
Deprecated:
test.'''"""
def GetOutputOfDependencyTestCase(self, options):
# Create these dynamically to not interfere with Bazel package structure:
temp_dir = tempfile.mkdtemp()
try:
open(os.path.join(temp_dir, "WORKSPACE"), "a").close()
open(os.path.join(temp_dir, "BUILD"), "a").close()
with open(os.path.join(temp_dir, "dependencies.bzl"), "a") as f:
f.write("'''Docstring'''\nload(':import.bzl', 'foo')\nfoo()")
with open(os.path.join(temp_dir, "import.bzl"), "a") as f:
f.write(self.IMPORT_BZL_CONTENTS)
output = None
try:
subprocess.check_output([
testenv.SKYLINT_BINARY_PATH,
os.path.join(temp_dir, "dependencies.bzl")
] + options)
except subprocess.CalledProcessError as e:
output = e.output.decode("utf-8")
return output
finally:
shutil.rmtree(temp_dir)
def testDependencyAnalysis(self):
output = self.GetOutputOfDependencyTestCase([])
self.assertIn("import.bzl) is deprecated: test.", output)
def testSingleFileModeWorks(self):
output = self.GetOutputOfDependencyTestCase(["--single-file"])
self.assertEqual(output, None)
if __name__ == "__main__":
unittest.main()
|
