Merge "Add initial header checker."
diff --git a/tools/checkstyle/LICENSE b/tools/checkstyle/LICENSE
deleted file mode 100644
index c1f5472..0000000
--- a/tools/checkstyle/LICENSE
+++ /dev/null
@@ -1,502 +0,0 @@
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
- This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
- When we speak of free software, we are referring to freedom of use,
-not price. Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
- To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
- For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
- We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
- To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
- Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
- Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
- When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
- We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-
- For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
- In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
- Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
- The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
- GNU LESSER GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
- A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
- The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
- "Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
- Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
- 1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
- You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
- 2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) The modified work must itself be a software library.
-
- b) You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-
- c) You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-
- d) If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
-
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
- Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
- This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
- 4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
- If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
- However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
- When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
- If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
- Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
- 6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
- You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
- a) Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
-
- b) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
-
- c) Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
-
- d) If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
-
- e) Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
-
- For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
- It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
- 7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
- a) Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
-
- b) Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
-
- 8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License. However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
- 9. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
- 10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
- 11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded. In such case, this License incorporates the limitation as if
-written in the body of this License.
-
- 13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
- 14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission. For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this. Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
- NO WARRANTY
-
- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Libraries
-
- If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change. You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
- To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
- <one line to give the library's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2.1 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the
- library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
- <signature of Ty Coon>, 1 April 1990
- Ty Coon, President of Vice
-
-That's all there is to it!
diff --git a/tools/checkstyle/README b/tools/checkstyle/README
deleted file mode 100644
index cc8ce50..0000000
--- a/tools/checkstyle/README
+++ /dev/null
@@ -1,29 +0,0 @@
-Description:
-Checkstyle is used by developers to validate Java code style before running repo upload.
-
-It can be invoked in two ways.
-1. To check style of entire specific files:
-checkstyle.py -f FILE [FILE ...]
-2. To check style of the lines modified in the latest commit:
-checkstyle.py
-
-Projects used:
-* Name: Checkstyle
- Description: Checkstyle is a development tool to help programmers write Java code that
- adheres to a coding standard.
- URL: http://checkstyle.sourceforge.net/
- Version: 6.12.1
- License: LGPL 2.1
- License File: LICENSE
- Local Modifications:
- - Downloaded checkstyle-6.12.1-all.jar without source code.
-
-* Name: Git-Lint
- Description: Git-lint is a tool to run lint checks on only files changed in
- the latest commit.
- URL: https://github.com/sk-/git-lint/
- Version: 0.0.8
- License: Apache 2.0
- License File: gitlint/LICENSE
- Local Modifications:
- - Downloaded gitlint/git.py and git/utils.py files individually.
diff --git a/tools/checkstyle/android-style.xml b/tools/checkstyle/android-style.xml
deleted file mode 100644
index a6139d4..0000000
--- a/tools/checkstyle/android-style.xml
+++ /dev/null
@@ -1,31 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Copyright (C) 2016 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.
--->
-<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd" [
- <!ENTITY defaultCopyrightCheck SYSTEM "default-copyright-check.xml">
- <!ENTITY defaultJavadocChecks SYSTEM "default-javadoc-checks.xml">
- <!ENTITY defaultTreewalkerChecks SYSTEM "default-treewalker-checks.xml">
- <!ENTITY defaultModuleChecks SYSTEM "default-module-checks.xml">
-]>
-
-<module name="Checker">
- &defaultModuleChecks;
- &defaultCopyrightCheck;
- <module name="TreeWalker">
- &defaultJavadocChecks;
- &defaultTreewalkerChecks;
- </module>
-</module>
diff --git a/tools/checkstyle/checkstyle.jar b/tools/checkstyle/checkstyle.jar
deleted file mode 100644
index 899caf3..0000000
--- a/tools/checkstyle/checkstyle.jar
+++ /dev/null
Binary files differ
diff --git a/tools/checkstyle/checkstyle.py b/tools/checkstyle/checkstyle.py
deleted file mode 100755
index 39ca181..0000000
--- a/tools/checkstyle/checkstyle.py
+++ /dev/null
@@ -1,360 +0,0 @@
-#!/usr/bin/python
-
-#
-# Copyright 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.
-#
-
-"""Script that is used by developers to run style checks on Java files."""
-
-import argparse
-import errno
-import os
-import shutil
-import subprocess
-import sys
-import tempfile
-import xml.dom.minidom
-import gitlint.git as git
-
-def _FindFoldersContaining(root, wanted):
- """Searches recursively from root to find directories that has a file with
- the given name.
-
- Args:
- root: Root folder to start the search from.
- wanted: The filename that we are looking for.
-
- Returns:
- List of folders that has a file with the given name
- """
-
- if os.path.islink(root):
- return []
- result = []
- for fileName in os.listdir(root):
- filePath = os.path.join(root, fileName)
- if os.path.isdir(filePath):
- subResult = _FindFoldersContaining(filePath, wanted)
- result.extend(subResult)
- else:
- if fileName == wanted:
- result.append(root)
- return result
-
-MAIN_DIRECTORY = os.path.normpath(os.path.dirname(__file__))
-CHECKSTYLE_JAR = os.path.join(MAIN_DIRECTORY, 'checkstyle.jar')
-CHECKSTYLE_STYLE = os.path.join(MAIN_DIRECTORY, 'android-style.xml')
-FORCED_RULES = ['com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck',
- 'com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck']
-SKIPPED_RULES_FOR_TEST_FILES = ['com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck',
- 'com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck']
-SUBPATH_FOR_TEST_FILES = ['/tests/', '/test/', '/androidTest/']
-SUBPATH_FOR_TEST_DATA_FILES = _FindFoldersContaining(os.path.dirname(os.getcwd()),
- "IGNORE_CHECKSTYLE")
-ERROR_UNCOMMITTED = 'You need to commit all modified files before running Checkstyle\n'
-ERROR_UNTRACKED = 'You have untracked java files that are not being checked:\n'
-
-
-def RunCheckstyleOnFiles(java_files, classpath=CHECKSTYLE_JAR, config_xml=CHECKSTYLE_STYLE):
- """Runs Checkstyle checks on a given set of java_files.
-
- Args:
- java_files: A list of files to check.
- classpath: The colon-delimited list of JARs in the classpath.
- config_xml: Path of the checkstyle XML configuration file.
-
- Returns:
- A tuple of errors and warnings.
- """
- print 'Running Checkstyle on inputted files'
- java_files = map(os.path.abspath, java_files)
- stdout = _ExecuteCheckstyle(java_files, classpath, config_xml)
- (errors, warnings) = _ParseAndFilterOutput(stdout)
- _PrintErrorsAndWarnings(errors, warnings)
- return errors, warnings
-
-
-def RunCheckstyleOnACommit(commit,
- classpath=CHECKSTYLE_JAR,
- config_xml=CHECKSTYLE_STYLE,
- file_whitelist=None):
- """Runs Checkstyle checks on a given commit.
-
- It will run Checkstyle on the changed Java files in a specified commit SHA-1
- and if that is None it will fallback to check the latest commit of the
- currently checked out branch.
-
- Args:
- commit: A full 40 character SHA-1 of a commit to check.
- classpath: The colon-delimited list of JARs in the classpath.
- config_xml: Path of the checkstyle XML configuration file.
- file_whitelist: A list of whitelisted file paths that should be checked.
-
- Returns:
- A tuple of errors and warnings.
- """
- explicit_commit = commit is not None
- if not explicit_commit:
- _WarnIfUntrackedFiles()
- commit = git.last_commit()
- print 'Running Checkstyle on %s commit' % commit
- commit_modified_files = _GetModifiedFiles(commit, explicit_commit)
- commit_modified_files = _FilterFiles(commit_modified_files, file_whitelist)
- if not commit_modified_files.keys():
- print 'No Java files to check'
- return [], []
-
- (tmp_dir, tmp_file_map) = _GetTempFilesForCommit(
- commit_modified_files.keys(), commit)
-
- java_files = tmp_file_map.keys()
- stdout = _ExecuteCheckstyle(java_files, classpath, config_xml)
-
- # Remove all the temporary files.
- shutil.rmtree(tmp_dir)
-
- (errors, warnings) = _ParseAndFilterOutput(stdout,
- commit,
- commit_modified_files,
- tmp_file_map)
- _PrintErrorsAndWarnings(errors, warnings)
- return errors, warnings
-
-
-def _WarnIfUntrackedFiles(out=sys.stdout):
- """Prints a warning and a list of untracked files if needed."""
- root = git.repository_root()
- untracked_files = git.modified_files(root, False)
- untracked_files = {f for f in untracked_files if f.endswith('.java')}
- if untracked_files:
- out.write(ERROR_UNTRACKED)
- for untracked_file in untracked_files:
- out.write(untracked_file + '\n')
- out.write('\n')
-
-
-def _PrintErrorsAndWarnings(errors, warnings):
- """Prints given errors and warnings."""
- if errors:
- print 'ERRORS:'
- print '\n'.join(errors)
- if warnings:
- print 'WARNINGS:'
- print '\n'.join(warnings)
-
-
-def _ExecuteCheckstyle(java_files, classpath, config_xml):
- """Runs Checkstyle to check give Java files for style errors.
-
- Args:
- java_files: A list of Java files that needs to be checked.
- classpath: The colon-delimited list of JARs in the classpath.
- config_xml: Path of the checkstyle XML configuration file.
-
- Returns:
- Checkstyle output in XML format.
- """
- # Run checkstyle
- checkstyle_env = os.environ.copy()
- checkstyle_env['JAVA_CMD'] = 'java'
- try:
- check = subprocess.Popen(['java', '-cp', classpath,
- 'com.puppycrawl.tools.checkstyle.Main', '-c',
- config_xml, '-f', 'xml'] + java_files,
- stdout=subprocess.PIPE, env=checkstyle_env)
- stdout, _ = check.communicate()
- except OSError as e:
- if e.errno == errno.ENOENT:
- print 'Error running Checkstyle!'
- sys.exit(1)
-
- # A work-around for Checkstyle printing error count to stdio.
- if 'Checkstyle ends with' in stdout.splitlines()[-1]:
- stdout = '\n'.join(stdout.splitlines()[:-1])
- return stdout
-
-
-def _ParseAndFilterOutput(stdout,
- sha=None,
- commit_modified_files=None,
- tmp_file_map=None):
- result_errors = []
- result_warnings = []
- root = xml.dom.minidom.parseString(stdout)
- for file_element in root.getElementsByTagName('file'):
- file_name = file_element.attributes['name'].value
- if tmp_file_map:
- file_name = tmp_file_map[file_name]
- modified_lines = None
- if commit_modified_files:
- modified_lines = git.modified_lines(file_name,
- commit_modified_files[file_name],
- sha)
- test_class = any(substring in file_name for substring
- in SUBPATH_FOR_TEST_FILES)
- test_data_class = any(substring in file_name for substring
- in SUBPATH_FOR_TEST_DATA_FILES)
- file_name = os.path.relpath(file_name)
- errors = file_element.getElementsByTagName('error')
- for error in errors:
- line = int(error.attributes['line'].value)
- rule = error.attributes['source'].value
- if _ShouldSkip(commit_modified_files, modified_lines, line, rule,
- test_class, test_data_class):
- continue
-
- column = ''
- if error.hasAttribute('column'):
- column = '%s:' % error.attributes['column'].value
- message = error.attributes['message'].value
- project = ''
- if os.environ.get('REPO_PROJECT'):
- project = '[' + os.environ.get('REPO_PROJECT') + '] '
-
- result = ' %s%s:%s:%s %s' % (project, file_name, line, column, message)
-
- severity = error.attributes['severity'].value
- if severity == 'error':
- result_errors.append(result)
- elif severity == 'warning':
- result_warnings.append(result)
- return result_errors, result_warnings
-
-
-def _ShouldSkip(commit_check, modified_lines, line, rule, test_class=False,
- test_data_class=False):
- """Returns whether an error on a given line should be skipped.
-
- Args:
- commit_check: Whether Checkstyle is being run on a specific commit.
- modified_lines: A list of lines that has been modified.
- line: The line that has a rule violation.
- rule: The type of rule that a given line is violating.
- test_class: Whether the file being checked is a test class.
- test_data_class: Whether the file being check is a class used as test data.
-
- Returns:
- A boolean whether a given line should be skipped in the reporting.
- """
- # None modified_lines means checked file is new and nothing should be skipped.
- if test_data_class:
- return True
- if test_class and rule in SKIPPED_RULES_FOR_TEST_FILES:
- return True
- if not commit_check:
- return False
- if modified_lines is None:
- return False
- return line not in modified_lines and rule not in FORCED_RULES
-
-
-def _GetModifiedFiles(commit, explicit_commit=False, out=sys.stdout):
- root = git.repository_root()
- pending_files = git.modified_files(root, True)
- if pending_files and not explicit_commit:
- out.write(ERROR_UNCOMMITTED)
- sys.exit(1)
-
- modified_files = git.modified_files(root, True, commit)
- modified_files = {f: modified_files[f] for f
- in modified_files if f.endswith('.java')}
- return modified_files
-
-
-def _FilterFiles(files, file_whitelist):
- if not file_whitelist:
- return files
- return {f: files[f] for f in files
- for whitelist in file_whitelist if whitelist in f}
-
-
-def _GetTempFilesForCommit(file_names, commit):
- """Creates a temporary snapshot of the files in at a commit.
-
- Retrieves the state of every file in file_names at a given commit and writes
- them all out to a temporary directory.
-
- Args:
- file_names: A list of files that need to be retrieved.
- commit: A full 40 character SHA-1 of a commit.
-
- Returns:
- A tuple of temprorary directory name and a directionary of
- temp_file_name: filename. For example:
-
- ('/tmp/random/', {'/tmp/random/blarg.java': 'real/path/to/file.java' }
- """
- tmp_dir_name = tempfile.mkdtemp()
- tmp_file_names = {}
- for file_name in file_names:
- rel_path = os.path.relpath(file_name)
- content = subprocess.check_output(
- ['git', 'show', commit + ':' + rel_path])
-
- tmp_file_name = os.path.join(tmp_dir_name, rel_path)
- # create directory for the file if it doesn't exist
- if not os.path.exists(os.path.dirname(tmp_file_name)):
- os.makedirs(os.path.dirname(tmp_file_name))
-
- tmp_file = open(tmp_file_name, 'w')
- tmp_file.write(content)
- tmp_file.close()
- tmp_file_names[tmp_file_name] = file_name
- return tmp_dir_name, tmp_file_names
-
-
-def main(args=None):
- """Runs Checkstyle checks on a given set of java files or a commit.
-
- It will run Checkstyle on the list of java files first, if unspecified,
- then the check will be run on a specified commit SHA-1 and if that
- is None it will fallback to check the latest commit of the currently checked
- out branch.
- """
- parser = argparse.ArgumentParser()
- parser.add_argument('--file', '-f', nargs='+')
- parser.add_argument('--sha', '-s')
- parser.add_argument('--config_xml', '-c')
- parser.add_argument('--file_whitelist', '-fw', nargs='+')
- parser.add_argument('--add_classpath', '-p')
- args = parser.parse_args()
-
- config_xml = args.config_xml or CHECKSTYLE_STYLE
-
- if not os.path.exists(config_xml):
- print 'Java checkstyle configuration file is missing'
- sys.exit(1)
-
- classpath = CHECKSTYLE_JAR
-
- if args.add_classpath:
- classpath = args.add_classpath + ':' + classpath
-
- if args.file:
- # Files to check were specified via command line.
- (errors, warnings) = RunCheckstyleOnFiles(args.file, classpath, config_xml)
- else:
- (errors, warnings) = RunCheckstyleOnACommit(args.sha, classpath, config_xml,
- args.file_whitelist)
-
- if errors or warnings:
- sys.exit(1)
-
- print 'SUCCESS! NO ISSUES FOUND'
- sys.exit(0)
-
-
-if __name__ == '__main__':
- main()
diff --git a/tools/checkstyle/default-copyright-check.xml b/tools/checkstyle/default-copyright-check.xml
deleted file mode 100644
index e36f1c7..0000000
--- a/tools/checkstyle/default-copyright-check.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Copyright (C) 2016 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.
--->
-<module name="RegexpHeader">
- <property name="severity" value="error"/>
- <message key="header.mismatch"
- value="Android Copyright header seems to be incorrect. Expected ''{0}'' on this line."/>
- <property name="header" value="^/\*\n \* Copyright \([Cc]\) [0-9]{4} The Android Open Source Project\n \*\n \* Licensed under the Apache License, Version 2\.0 \(the \"License\"\);\n \* you may not use this file except in compliance with the License.\n \* You may obtain a copy of the License at\n \*\n \* http:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0\n \*\n \* Unless required by applicable law or agreed to in writing, software\n \* distributed under the License is distributed on an "AS IS" BASIS,\n \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.\n \* See the License for the specific language governing permissions and\n \* limitations under the License\.\n \*\/" />
-</module>
diff --git a/tools/checkstyle/default-javadoc-checks.xml b/tools/checkstyle/default-javadoc-checks.xml
deleted file mode 100644
index b17f2c6..0000000
--- a/tools/checkstyle/default-javadoc-checks.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Copyright (C) 2016 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.
--->
-<module name="JavadocType">
- <property name="severity" value="warning"/>
- <property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
- <property name="scope" value="public"/>
- <property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
- <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
-</module>
-<module name="JavadocMethod">
- <property name="severity" value="error"/>
- <property name="scope" value="public"/>
- <property name="tokens" value="METHOD_DEF"/>
- <property name="allowMissingParamTags" value="true"/>
- <property name="allowMissingPropertyJavadoc" value="true"/>
- <property name="allowMissingReturnTag" value="true"/>
- <property name="allowMissingThrowsTags" value="true"/>
-</module>
diff --git a/tools/checkstyle/default-module-checks.xml b/tools/checkstyle/default-module-checks.xml
deleted file mode 100644
index 246e89a..0000000
--- a/tools/checkstyle/default-module-checks.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Copyright (C) 2016 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.
--->
-<property name="severity" value="warning"/>
-<property name="charset" value="UTF-8"/>
-<module name="SuppressionCommentFilter">
- <property name="offCommentFormat" value="CHECKSTYLE:OFF IndentationCheck"/>
- <property name="onCommentFormat" value="CHECKSTYLE:ON IndentationCheck"/>
- <property name="checkFormat" value="IndentationCheck"/>
-</module>
-<module name="SuppressionCommentFilter">
- <property name="offCommentFormat" value="CHECKSTYLE:OFF Generated code"/>
- <property name="onCommentFormat" value="CHECKSTYLE:ON Generated code"/>
-</module>
-<module name="FileTabCharacter">
- <property name="severity" value="error"/>
-</module>
-<module name="NewlineAtEndOfFile">
- <property name="severity" value="error"/>
-</module>
-<module name="RegexpSingleline">
- <property name="severity" value="error"/>
- <property name="format" value="[ \t]+$"/>
- <property name="message" value="Trailing whitespace"/>
-</module>
diff --git a/tools/checkstyle/default-treewalker-checks.xml b/tools/checkstyle/default-treewalker-checks.xml
deleted file mode 100644
index 6e9e31b..0000000
--- a/tools/checkstyle/default-treewalker-checks.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Copyright (C) 2016 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.
--->
-<module name="AvoidStarImport">
- <property name="severity" value="error"/>
- <property name="excludes" value="org.junit.Assert,org.mockito.Mockito,org.mockito.MockitoAnnotations,org.hamcrest.Matchers"/>
-</module>
-<module name="IllegalCatch">
- <property name="severity" value="info"/>
-</module>
-<module name="RedundantImport">
- <message key="import.redundant" value="Redundant import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
- <property name="severity" value="error"/>
-</module>
-<module name="UnusedImports">
- <message key="import.unused" value="Unused import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
- <property name="severity" value="error"/>
- <property name="processJavadoc" value="true"/>
-</module>
-<module name="PackageName">
- <property name="severity" value="error"/>
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]{1,})*$"/>
-</module>
-<module name="SimplifyBooleanExpression">
- <property name="severity" value="error"/>
-</module>
-<module name="SimplifyBooleanReturn">
- <property name="severity" value="error"/>
-</module>
-<module name="TypeName">
- <property name="severity" value="error"/>
-</module>
-<module name="ConstantName">
- <property name="severity" value="error"/>
- <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|(s[A-Z][a-zA-Z0-9]*)$"/>
- <message key="name.invalidPattern" value="Static final field names must either be all caps (e.g. int HEIGHT_PX) for 'true' constants, or start with s (e.g. AtomicInteger sNextId or Runnable sSuspendTask) for fields with mutable state or that don't 'feel' like constants."/>
-</module>
-<!-- Non-public, non-static field names start with m. -->
-<module name="MemberName">
- <property name="severity" value="error"/>
- <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
- <property name="applyToPublic" value="false"/>
- <message key="name.invalidPattern" value="Non-public, non-static field names start with m."/>
-</module>
-<!-- Static field names start with s. -->
-<module name="StaticVariableName">
- <property name="severity" value="error"/>
- <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
- <property name="applyToPublic" value="false"/>
- <message key="name.invalidPattern" value="Static field names start with s."/>
-</module>
-<module name="MethodName">
- <property name="severity" value="error"/>
- <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
- <message key="name.invalidPattern" value="Method names should start with a lower case letter (e.g. getWidth())"/>
-</module>
-<module name="ParameterName">
- <property name="severity" value="error"/>
-</module>
-<module name="LocalFinalVariableName">
- <property name="severity" value="error"/>
- <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
- <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
-</module>
-<module name="LocalVariableName">
- <property name="severity" value="error"/>
- <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
- <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
-</module>
-<module name="LineLength">
- <property name="severity" value="error"/>
- <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
- <property name="max" value="100"/>
-</module>
-<module name="LeftCurly">
- <property name="severity" value="error"/>
-</module>
-<module name="RightCurly">
- <property name="severity" value="error"/>
-</module>
-<module name="NeedBraces">
- <message key="needBraces" value="if, for, while, and do require curly braces unless they are single-line statements."/>
- <property name="severity" value="error"/>
- <property name="tokens" value="LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_IF"/>
- <property name="allowSingleLineStatement" value="true"/>
-</module>
-<module name="EmptyBlock">
- <property name="severity" value="error"/>
- <property name="option" value="text"/>
- <metadata name="altname" value="EmptyCatchBlock"/>
-</module>
-<module name="UpperEll">
- <property name="severity" value="error"/>
-</module>
-<module name="FallThrough">
- <property name="severity" value="error"/>
- <property name="reliefPattern" value=".*"/>
-</module>
-<module name="ModifierOrder">
- <property name="severity" value="error"/>
-</module>
-<module name="WhitespaceAround">
- <property name="severity" value="error"/>
- <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
- <property name="allowEmptyConstructors" value="true"/>
- <property name="allowEmptyMethods" value="true"/>
-</module>
-<module name="WhitespaceAfter">
- <property name="severity" value="error"/>
- <property name="tokens" value="COMMA, SEMI, TYPECAST"/>
-</module>
-<module name="NoWhitespaceAfter">
- <property name="severity" value="error"/>
- <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
-</module>
-<module name="NoWhitespaceBefore">
- <property name="severity" value="error"/>
- <property name="allowLineBreaks" value="true"/>
- <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
-</module>
-<module name="GenericWhitespace">
- <property name="severity" value="error"/>
- <message key="ws.followed"
- value="GenericWhitespace ''{0}'' is followed by whitespace."/>
- <message key="ws.preceded"
- value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
- <message key="ws.illegalFollow"
- value="GenericWhitespace ''{0}'' should followed by whitespace."/>
- <message key="ws.notPreceded"
- value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
-</module>
-<module name="EmptyStatement">
- <property name="severity" value="error"/>
-</module>
-<module name="NoFinalizer">
- <property name="severity" value="info"/>
-</module>
-<module name="ParenPad">
- <property name="severity" value="error"/>
-</module>
-<module name="MethodParamPad">
- <property name="severity" value="error"/>
-</module>
-<module name="ImportOrder">
- <property name="severity" value="error"/>
- <message key="import.ordering" value="Wrong order for {0} import. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
- <property name="groups" value="android, com.android, dalvik, com, gov, junit, libcore, net, org, java, javax"/>
- <property name="ordered" value="true"/>
- <property name="option" value="top"/>
- <property name="separated" value="true"/>
-</module>
-<module name="Indentation">
- <property name="severity" value="error"/>
- <property name="basicOffset" value="4"/>
- <property name="throwsIndent" value="8"/>
- <property name="lineWrappingIndentation" value="8"/>
-</module>
-<module name="OperatorWrap">
- <property name="severity" value="error"/>
- <property name="option" value="NL" />
- <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR " />
-</module>
-<module name="OperatorWrap">
- <property name="severity" value="error"/>
- <property name="option" value="eol"/>
- <property name="tokens" value="ASSIGN"/>
-</module>
-<module name="SeparatorWrap">
- <property name="severity" value="error"/>
- <property name="tokens" value="DOT"/>
- <property name="option" value="nl"/>
-</module>
-<module name="SeparatorWrap">
- <property name="severity" value="error"/>
- <property name="tokens" value="COMMA"/>
- <property name="option" value="EOL"/>
-</module>
-<module name="MissingDeprecated">
- <property name="severity" value="error"/>
-</module>
-<module name="MissingOverride">
- <property name="severity" value="error"/>
-</module>
-<module name="OneTopLevelClass">
- <property name="severity" value="error"/>
-</module>
-<module name="StringLiteralEquality">
- <property name="severity" value="error"/>
-</module>
-<module name="ArrayTypeStyle">
- <property name="severity" value="error"/>
-</module>
-<module name="RedundantModifier">
- <property name="severity" value="error"/>
-</module>
-<module name="OuterTypeFilename">
- <property name="severity" value="error"/>
-</module>
-<module name="FileContentsHolder"/>
diff --git a/tools/checkstyle/gitlint/LICENSE b/tools/checkstyle/gitlint/LICENSE
deleted file mode 100644
index d645695..0000000
--- a/tools/checkstyle/gitlint/LICENSE
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- 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.
diff --git a/tools/checkstyle/gitlint/__init__.py b/tools/checkstyle/gitlint/__init__.py
deleted file mode 100644
index d89c41c..0000000
--- a/tools/checkstyle/gitlint/__init__.py
+++ /dev/null
@@ -1 +0,0 @@
-# Empty placeholder file to make gitlint importable from checkstyle.py
diff --git a/tools/checkstyle/gitlint/git.py b/tools/checkstyle/gitlint/git.py
deleted file mode 100644
index 9d796f6..0000000
--- a/tools/checkstyle/gitlint/git.py
+++ /dev/null
@@ -1,136 +0,0 @@
-# Copyright 2013-2014 Sebastian Kreft
-#
-# 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.
-"""Functions to get information from git."""
-
-import os.path
-import subprocess
-
-import gitlint.utils as utils
-
-
-def repository_root():
- """Returns the root of the repository as an absolute path."""
- try:
- root = subprocess.check_output(['git', 'rev-parse', '--show-toplevel'],
- stderr=subprocess.STDOUT).strip()
- # Convert to unicode first
- return root.decode('utf-8')
- except subprocess.CalledProcessError:
- return None
-
-
-def last_commit():
- """Returns the SHA1 of the last commit."""
- try:
- root = subprocess.check_output(['git', 'rev-parse', 'HEAD'],
- stderr=subprocess.STDOUT).strip()
- # Convert to unicode first
- return root.decode('utf-8')
- except subprocess.CalledProcessError:
- return None
-
-
-def _remove_filename_quotes(filename):
- """Removes the quotes from a filename returned by git status."""
- if filename.startswith('"') and filename.endswith('"'):
- return filename[1:-1]
-
- return filename
-
-
-def modified_files(root, tracked_only=False, commit=None):
- """Returns a list of files that has been modified since the last commit.
-
- Args:
- root: the root of the repository, it has to be an absolute path.
- tracked_only: exclude untracked files when True.
- commit: SHA1 of the commit. If None, it will get the modified files in the
- working copy.
-
- Returns: a dictionary with the modified files as keys, and additional
- information as value. In this case it adds the status returned by
- git status.
- """
- assert os.path.isabs(root), "Root has to be absolute, got: %s" % root
-
- if commit:
- return _modified_files_with_commit(root, commit)
-
- # Convert to unicode and split
- status_lines = subprocess.check_output([
- 'git', 'status', '--porcelain', '--untracked-files=all',
- '--ignore-submodules=all']).decode('utf-8').split(os.linesep)
-
- modes = ['M ', ' M', 'A ', 'AM', 'MM']
- if not tracked_only:
- modes.append(r'\?\?')
- modes_str = '|'.join(modes)
-
- modified_file_status = utils.filter_lines(
- status_lines,
- r'(?P<mode>%s) (?P<filename>.+)' % modes_str,
- groups=('filename', 'mode'))
-
- return dict((os.path.join(root, _remove_filename_quotes(filename)), mode)
- for filename, mode in modified_file_status)
-
-
-def _modified_files_with_commit(root, commit):
- # Convert to unicode and split
- status_lines = subprocess.check_output(
- ['git', 'diff-tree', '-r', '--root', '--no-commit-id', '--name-status',
- commit]).decode('utf-8').split(os.linesep)
-
- modified_file_status = utils.filter_lines(
- status_lines,
- r'(?P<mode>A|M)\s(?P<filename>.+)',
- groups=('filename', 'mode'))
-
- # We need to add a space to the mode, so to be compatible with the output
- # generated by modified files.
- return dict((os.path.join(root, _remove_filename_quotes(filename)),
- mode + ' ') for filename, mode in modified_file_status)
-
-
-def modified_lines(filename, extra_data, commit=None):
- """Returns the lines that have been modifed for this file.
-
- Args:
- filename: the file to check.
- extra_data: is the extra_data returned by modified_files. Additionally, a
- value of None means that the file was not modified.
- commit: the complete sha1 (40 chars) of the commit.
-
- Returns: a list of lines that were modified, or None in case all lines are
- new.
- """
- if extra_data is None:
- return []
- if extra_data not in ('M ', ' M', 'MM'):
- return None
-
- if commit is None:
- commit = '0' * 40
- commit = commit.encode('utf-8')
-
- # Split as bytes, as the output may have some non unicode characters.
- blame_lines = subprocess.check_output(
- ['git', 'blame', commit, '--porcelain', '--', filename]).split(
- os.linesep.encode('utf-8'))
- modified_line_numbers = utils.filter_lines(
- blame_lines,
- commit + br' (?P<line>\d+) (\d+)',
- groups=('line',))
-
- return list(map(int, modified_line_numbers))
diff --git a/tools/checkstyle/gitlint/utils.py b/tools/checkstyle/gitlint/utils.py
deleted file mode 100644
index c9e28ea..0000000
--- a/tools/checkstyle/gitlint/utils.py
+++ /dev/null
@@ -1,114 +0,0 @@
-# Copyright 2013-2014 Sebastian Kreft
-#
-# 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.
-"""Common function used across modules."""
-
-import io
-import os
-import re
-
-
-def filter_lines(lines, filter_regex, groups=None):
- """Filters out the lines not matching the pattern.
-
- Args:
- lines: list[string]: lines to filter.
- pattern: string: regular expression to filter out lines.
-
- Returns: list[string]: the list of filtered lines.
- """
- pattern = re.compile(filter_regex)
- for line in lines:
- match = pattern.search(line)
- if match:
- if groups is None:
- yield line
- elif len(groups) == 1:
- yield match.group(groups[0])
- else:
- matched_groups = match.groupdict()
- yield tuple(matched_groups.get(group) for group in groups)
-
-
-# TODO(skreft): add test
-def which(program):
- """Returns a list of paths where the program is found."""
- if (os.path.isabs(program) and os.path.isfile(program) and
- os.access(program, os.X_OK)):
- return [program]
-
- candidates = []
- locations = os.environ.get("PATH").split(os.pathsep)
- for location in locations:
- candidate = os.path.join(location, program)
- if os.path.isfile(candidate) and os.access(candidate, os.X_OK):
- candidates.append(candidate)
- return candidates
-
-
-def programs_not_in_path(programs):
- """Returns all the programs that are not found in the PATH."""
- return [program for program in programs if not which(program)]
-
-
-def _open_for_write(filename):
- """Opens filename for writing, creating the directories if needed."""
- dirname = os.path.dirname(filename)
- if not os.path.exists(dirname):
- os.makedirs(dirname)
-
- return io.open(filename, 'w')
-
-
-def _get_cache_filename(name, filename):
- """Returns the cache location for filename and linter name."""
- filename = os.path.abspath(filename)[1:]
- home_folder = os.path.expanduser('~')
- base_cache_dir = os.path.join(home_folder, '.git-lint', 'cache')
-
- return os.path.join(base_cache_dir, name, filename)
-
-
-def get_output_from_cache(name, filename):
- """Returns the output from the cache if still valid.
-
- It checks that the cache file is defined and that its modification time is
- after the modification time of the original file.
-
- Args:
- name: string: name of the linter.
- filename: string: path of the filename for which we are retrieving the
- output.
-
- Returns: a string with the output, if it is still valid, or None otherwise.
- """
- cache_filename = _get_cache_filename(name, filename)
- if (os.path.exists(cache_filename) and
- os.path.getmtime(filename) < os.path.getmtime(cache_filename)):
- with io.open(cache_filename) as f:
- return f.read()
-
- return None
-
-
-def save_output_in_cache(name, filename, output):
- """Saves output in the cache location.
-
- Args:
- name: string: name of the linter.
- filename: string: path of the filename for which we are saving the output.
- output: string: full output (not yet filetered) of the lint command.
- """
- cache_filename = _get_cache_filename(name, filename)
- with _open_for_write(cache_filename) as f:
- f.write(output)
diff --git a/tools/checkstyle/tests.py b/tools/checkstyle/tests.py
deleted file mode 100755
index 74b325e..0000000
--- a/tools/checkstyle/tests.py
+++ /dev/null
@@ -1,167 +0,0 @@
-#!/usr/bin/python
-
-#
-# Copyright 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.
-#
-
-"""Tests the Checkstyle script used to run style checks on Java files."""
-
-from StringIO import StringIO
-import unittest
-import checkstyle
-
-
-TEST_RULE = u'com.puppycrawl.tools.checkstyle.checks.BANANAS'
-TEST_SHA = u'0000deadbeef000000deadbeef00deadbeef0000'
-TEST_ROOT = u'/usr/local/android/master/framework/support'
-TEST_FILE1 = TEST_ROOT + u'/Blarg.java'
-TEST_FILE2 = TEST_ROOT + u'/Blarg2.java'
-TEST_FILE_NON_JAVA = TEST_ROOT + u'/blarg.cc'
-FILE_ADDED = u'A '
-FILE_MODIFIED = u'M '
-FILE_UNTRACKED = u'??'
-
-
-def mock_repository_root():
- return TEST_ROOT
-
-
-def mock_last_commit():
- return TEST_SHA
-
-
-def mock_modified_files_good(root, tracked_only=False, commit=None):
- if commit:
- return {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED}
- return {}
-
-
-def mock_modified_files_uncommitted(root, tracked_only=False, commit=None):
- if tracked_only and not commit:
- return {TEST_FILE1: FILE_MODIFIED}
- if commit:
- return {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED}
- return {}
-
-
-def mock_modified_files_untracked(root, tracked_only=False, commit=None):
- if not tracked_only:
- return {TEST_FILE1: FILE_UNTRACKED}
- if commit:
- return {TEST_FILE2: FILE_ADDED}
- return {}
-
-
-def mock_modified_files_non_java(root, tracked_only=False, commit=None):
- if commit:
- return {TEST_FILE1: FILE_MODIFIED, TEST_FILE_NON_JAVA: FILE_ADDED}
- return {}
-
-
-class TestCheckstyle(unittest.TestCase):
-
- def setUp(self):
- checkstyle.git.repository_root = mock_repository_root
- checkstyle.git.last_commit = mock_last_commit
-
- def test_ShouldSkip(self):
- # Skip checks for explicit git commit.
- self.assertFalse(checkstyle._ShouldSkip(True, None, 1, TEST_RULE))
- self.assertTrue(checkstyle._ShouldSkip(True, [], 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(True, [1], 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, TEST_RULE))
- self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, TEST_RULE))
- for rule in checkstyle.FORCED_RULES:
- self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, rule))
- self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 4, rule))
-
- # Skip checks for explicitly checked files.
- self.assertFalse(checkstyle._ShouldSkip(False, None, 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(False, [], 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(False, [1], 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 1, TEST_RULE))
- self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 4, TEST_RULE))
- for rule in checkstyle.FORCED_RULES:
- self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 1, rule))
- self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 4, rule))
-
- # Skip checks for test classes.
- self.assertFalse(checkstyle._ShouldSkip(True, None, 1, TEST_RULE, True))
- self.assertTrue(checkstyle._ShouldSkip(True, [], 1, TEST_RULE, True))
- self.assertFalse(checkstyle._ShouldSkip(True, [1], 1, TEST_RULE, True))
- self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, TEST_RULE, True))
- self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, TEST_RULE, True))
- for rule in checkstyle.SKIPPED_RULES_FOR_TEST_FILES:
- self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 1, rule, True))
- self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, rule, True))
-
- def test_GetModifiedFiles(self):
- checkstyle.git.modified_files = mock_modified_files_good
- out = StringIO()
- files = checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
- output = out.getvalue()
- self.assertEqual(output, '')
- self.assertEqual(files, {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED})
-
- def test_GetModifiedFilesUncommitted(self):
- checkstyle.git.modified_files = mock_modified_files_uncommitted
- with self.assertRaises(SystemExit):
- out = StringIO()
- checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
- self.assertEqual(out.getvalue(), checkstyle.ERROR_UNCOMMITTED)
-
- def test_GetModifiedFilesUncommittedExplicitCommit(self):
- checkstyle.git.modified_files = mock_modified_files_uncommitted
- out = StringIO()
- files = checkstyle._GetModifiedFiles(mock_last_commit(), True, out=out)
- output = out.getvalue()
- self.assertEqual(output, '')
- self.assertEqual(files, {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED})
-
- def test_GetModifiedFilesNonJava(self):
- checkstyle.git.modified_files = mock_modified_files_non_java
- out = StringIO()
- files = checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
- output = out.getvalue()
- self.assertEqual(output, '')
- self.assertEqual(files, {TEST_FILE1: FILE_MODIFIED})
-
- def test_WarnIfUntrackedFiles(self):
- checkstyle.git.modified_files = mock_modified_files_untracked
- out = StringIO()
- checkstyle._WarnIfUntrackedFiles(out=out)
- output = out.getvalue()
- self.assertEqual(output, checkstyle.ERROR_UNTRACKED + TEST_FILE1 + '\n\n')
-
- def test_WarnIfUntrackedFilesNoUntracked(self):
- checkstyle.git.modified_files = mock_modified_files_good
- out = StringIO()
- checkstyle._WarnIfUntrackedFiles(out=out)
- output = out.getvalue()
- self.assertEqual(output, '')
-
- def test_FilterFiles(self):
- files = {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED}
- output = checkstyle._FilterFiles(files, None)
- self.assertEqual(files, output)
- output = checkstyle._FilterFiles(files, ['Blarg2'])
- self.assertEqual({TEST_FILE2: FILE_ADDED}, output)
- output = checkstyle._FilterFiles(files, ['Blarg'])
- self.assertEqual(files, output)
- output = checkstyle._FilterFiles(files, ['FunkyTown'])
- self.assertEqual({}, output)
-
-if __name__ == '__main__':
- unittest.main()
