Compare commits
148 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
82ed191bc9 | ||
|
|
92ff315fb4 | ||
|
|
f4cebdc054 | ||
|
|
d174f9e3e3 | ||
|
|
c8ba8f7e99 | ||
|
|
63dd8313f8 | ||
|
|
7be5867675 | ||
|
|
6061a2c4cc | ||
|
|
09118e417c | ||
|
|
71b90ae208 | ||
|
|
8844855353 | ||
|
|
0eb310e102 | ||
|
|
cdd094220c | ||
|
|
7a7d98c96a | ||
|
|
9f99f25db5 | ||
|
|
8c839a20c2 | ||
|
|
8e6e851c5b | ||
|
|
edd4cca02f | ||
|
|
867970258e | ||
|
|
d0cb5998c4 | ||
|
|
a5c97220e7 | ||
|
|
598e5e4370 | ||
|
|
03076ee214 | ||
|
|
eabd349902 | ||
|
|
1f1757ced4 | ||
|
|
59d5bffbec | ||
|
|
53da21934d | ||
|
|
0c36d0175c | ||
|
|
20545febe5 | ||
|
|
88ebcbbb93 | ||
|
|
08615ec4f8 | ||
|
|
29aceb430a | ||
|
|
159e29ea6a | ||
|
|
f9198b7a9b | ||
|
|
44236077dd | ||
|
|
76f47e91ca | ||
|
|
f98bed1085 | ||
|
|
a483524b63 | ||
|
|
3a017a5a22 | ||
|
|
bab8137e2b | ||
|
|
41733fc7a5 | ||
|
|
688858e639 | ||
|
|
dca3a54e63 | ||
|
|
2dcfbd7e0d | ||
|
|
73d7a608e8 | ||
|
|
1c0f164fbf | ||
|
|
46e9108419 | ||
|
|
2f9e3cc71b | ||
|
|
b13a03815a | ||
|
|
9a7eec34b1 | ||
|
|
5b62548ece | ||
|
|
8fca8a7a33 | ||
|
|
69ef9a7272 | ||
|
|
d8d1d92545 | ||
|
|
7688567faa | ||
|
|
4e188f8801 | ||
|
|
5693b1dddf | ||
|
|
fa420499c7 | ||
|
|
adefe38a0d | ||
|
|
7e11082353 | ||
|
|
29c1c60143 | ||
|
|
b879e9a98f | ||
|
|
5956b20545 | ||
|
|
10ad302e2f | ||
|
|
73d9322813 | ||
|
|
ca0ebe4583 | ||
|
|
e6dc67fd0a | ||
|
|
611a560082 | ||
|
|
83384fa4cf | ||
|
|
3ab3784a75 | ||
|
|
2f75e92a66 | ||
|
|
64caa95b6a | ||
|
|
fff09fa2df | ||
|
|
316bee8c98 | ||
|
|
6c8af97a40 | ||
|
|
647d84ff94 | ||
|
|
8eb0d0ad74 | ||
|
|
4bc3d5a01c | ||
|
|
48c7d65c54 | ||
|
|
62fa4cbe39 | ||
|
|
8d38d349ac | ||
|
|
3f264806b9 | ||
|
|
9a82b99d4b | ||
|
|
ba140ad42c | ||
|
|
0e04ee29e6 | ||
|
|
ba9d86d645 | ||
|
|
3f4f13e848 | ||
|
|
f6bab05e8a | ||
|
|
c16eec4681 | ||
|
|
68618be4cc | ||
|
|
431a379c81 | ||
|
|
6b5948c06b | ||
|
|
dd163ed551 | ||
|
|
14c99da2bb | ||
|
|
cae100071a | ||
|
|
7cb7b4f669 | ||
|
|
d2b5f69309 | ||
|
|
a7d39b5492 | ||
|
|
4410bc3e23 | ||
|
|
97c446907c | ||
|
|
376a6ed484 | ||
|
|
a1eb9d7d2f | ||
|
|
45538fb08a | ||
|
|
be998593dd | ||
|
|
5ed496f471 | ||
|
|
dbbecb5875 | ||
|
|
7b147cb411 | ||
|
|
fc108e7cee | ||
|
|
792bdf99b4 | ||
|
|
92798dbda9 | ||
|
|
e3ebea6033 | ||
|
|
7983c66093 | ||
|
|
fee72d484e | ||
|
|
387d14f816 | ||
|
|
ba8a9d0ba1 | ||
|
|
26b5364be4 | ||
|
|
47d6534e75 | ||
|
|
237db5aeef | ||
|
|
6e9de02eac | ||
|
|
044c049462 | ||
|
|
48589176c7 | ||
|
|
38234a1d3c | ||
|
|
1bfd18097a | ||
|
|
08f99ccc19 | ||
|
|
7b6f024448 | ||
|
|
75b4758c95 | ||
|
|
0e98df2643 | ||
|
|
d4189083d0 | ||
|
|
67d13d60ae | ||
|
|
96465008ab | ||
|
|
847f7e3fff | ||
|
|
6a24781f96 | ||
|
|
33224a04e4 | ||
|
|
fd9d2a00ff | ||
|
|
0b0251bacc | ||
|
|
ad5cec9c6c | ||
|
|
fb14cbdbd9 | ||
|
|
8288a6f331 | ||
|
|
9d8b0d4d2c | ||
|
|
39c878c819 | ||
|
|
222f7a27c1 | ||
|
|
effb4db3b4 | ||
|
|
d617eb70ae | ||
|
|
f09aef4f89 | ||
|
|
01c12f2462 | ||
|
|
918f15b68d | ||
|
|
97e2210ec9 | ||
|
|
1934206cef |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,2 +1,5 @@
|
||||
__pycache__
|
||||
*.py[cod]
|
||||
/docs/_build
|
||||
/dist
|
||||
/yamllint.egg-info
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
language: python
|
||||
python:
|
||||
- 2.6
|
||||
- 2.7
|
||||
- 3.3
|
||||
- 3.4
|
||||
@@ -12,7 +11,7 @@ install:
|
||||
- pip install .
|
||||
script:
|
||||
- flake8 .
|
||||
- yamllint $(git ls-files '*.yml')
|
||||
- yamllint $(git ls-files '*.yaml' '*.yml')
|
||||
- coverage run --source=yamllint setup.py test
|
||||
after_success:
|
||||
coveralls
|
||||
|
||||
3
MANIFEST.in
Normal file
3
MANIFEST.in
Normal file
@@ -0,0 +1,3 @@
|
||||
include LICENSE
|
||||
include README.rst
|
||||
include docs/*
|
||||
@@ -1,6 +0,0 @@
|
||||
# yamllint
|
||||
|
||||
A linter for YAML files.
|
||||
|
||||
[](https://travis-ci.org/adrienverge/yamllint)
|
||||
[](https://coveralls.io/github/adrienverge/yamllint?branch=master)
|
||||
127
README.rst
Normal file
127
README.rst
Normal file
@@ -0,0 +1,127 @@
|
||||
yamllint
|
||||
========
|
||||
|
||||
A linter for YAML files.
|
||||
|
||||
yamllint does not only check for syntax validity, but for weirdnesses like key
|
||||
repetition and cosmetic problems such as lines length, trailing spaces,
|
||||
indentation, etc.
|
||||
|
||||
.. image::
|
||||
https://travis-ci.org/adrienverge/yamllint.svg?branch=master
|
||||
:target: https://travis-ci.org/adrienverge/yamllint
|
||||
:alt: CI tests status
|
||||
.. image::
|
||||
https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
|
||||
:target: https://coveralls.io/github/adrienverge/yamllint?branch=master
|
||||
:alt: Code coverage status
|
||||
.. image:: https://readthedocs.org/projects/yamllint/badge/?version=latest
|
||||
:target: http://yamllint.readthedocs.org/en/latest/?badge=latest
|
||||
:alt: Documentation status
|
||||
|
||||
Written in Python (compatible with Python 2 & 3).
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
http://yamllint.readthedocs.io/
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Screenshot
|
||||
^^^^^^^^^^
|
||||
|
||||
.. image:: docs/screenshot.png
|
||||
:alt: yamllint screenshot
|
||||
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
On Fedora / CentOS:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo dnf install yamllint
|
||||
|
||||
On Debian 9+ / Ubuntu 16.04+:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo apt-get install yamllint
|
||||
|
||||
Alternatively using pip, the Python package manager:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo pip install yamllint
|
||||
|
||||
Usage
|
||||
^^^^^
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Lint one or more files
|
||||
yamllint my_file.yml my_other_file.yaml ...
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Lint all YAML files in a directory
|
||||
yamllint .
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Use a pre-defined lint configuration
|
||||
yamllint -d relaxed file.yaml
|
||||
|
||||
# Use a custom lint configuration
|
||||
yamllint -c /path/to/myconfig file-to-lint.yaml
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||
yamllint -f parsable file.yaml
|
||||
|
||||
`Read more in the complete documentation! <http://yamllint.readthedocs.io/>`_
|
||||
|
||||
Features
|
||||
^^^^^^^^
|
||||
|
||||
Here is a yamllint configuration file example:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
extends: default
|
||||
|
||||
rules:
|
||||
# 80 chars should be enough, but don't fail if a line is longer
|
||||
line-length:
|
||||
max: 80
|
||||
level: warning
|
||||
|
||||
# don't bother me with this rule
|
||||
indentation: disable
|
||||
|
||||
Within a YAML file, special comments can be used to disable checks for a single
|
||||
line:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
This line is waaaaaaaaaay too long # yamllint disable-line
|
||||
|
||||
or for a whole block:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
# yamllint disable rule:colons
|
||||
- Lorem : ipsum
|
||||
dolor : sit amet,
|
||||
consectetur : adipiscing elit
|
||||
# yamllint enable
|
||||
|
||||
`Read more in the complete documentation! <http://yamllint.readthedocs.io/>`_
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
`GPL version 3 <LICENSE>`_
|
||||
82
bin/yamllint
82
bin/yamllint
@@ -1,82 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import print_function
|
||||
import os.path
|
||||
import sys
|
||||
|
||||
import argparse
|
||||
|
||||
from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
|
||||
from yamllint import config
|
||||
from yamllint.errors import YamlLintConfigError
|
||||
from yamllint import lint
|
||||
from yamllint import output
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(prog=APP_NAME,
|
||||
description=APP_DESCRIPTION)
|
||||
parser.add_argument('files', metavar='FILES', nargs='+',
|
||||
help='files to check')
|
||||
parser.add_argument('-c', '--config', dest='config_file', action='store',
|
||||
help='path to a custom configuration')
|
||||
parser.add_argument('-f', '--format',
|
||||
choices=('parsable', 'standard'), default='standard',
|
||||
help='format for parsing output')
|
||||
parser.add_argument('-v', '--version', action='version',
|
||||
version='%s %s' % (APP_NAME, APP_VERSION))
|
||||
|
||||
# TODO: read from stdin when no filename?
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
try:
|
||||
if args.config_file is not None:
|
||||
conf = config.parse_config_from_file(args.config_file)
|
||||
elif os.path.isfile('.yamllint'):
|
||||
conf = config.parse_config_from_file('.yamllint')
|
||||
else:
|
||||
conf = config.parse_config('extends: default')
|
||||
except YamlLintConfigError as e:
|
||||
print(e, file=sys.stderr)
|
||||
sys.exit(-1)
|
||||
|
||||
return_code = 0
|
||||
|
||||
for file in args.files:
|
||||
if args.format != 'parsable':
|
||||
print('\033[4m%s\033[0m' % file)
|
||||
|
||||
try:
|
||||
with open(file) as f:
|
||||
for problem in lint(f, conf):
|
||||
if args.format == 'parsable':
|
||||
print(output.parsable_format(problem, file))
|
||||
else:
|
||||
print(output.standard_format(problem, file))
|
||||
|
||||
if return_code == 0 and problem.level == 'error':
|
||||
return_code = 1
|
||||
except EnvironmentError as e:
|
||||
print(e)
|
||||
return_code = -1
|
||||
|
||||
if args.format != 'parsable':
|
||||
print('')
|
||||
|
||||
sys.exit(return_code)
|
||||
177
docs/Makefile
Normal file
177
docs/Makefile
Normal file
@@ -0,0 +1,177 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yamllint.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yamllint.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/yamllint"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yamllint"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
42
docs/conf.py
Normal file
42
docs/conf.py
Normal file
@@ -0,0 +1,42 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# yamllint documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Jan 21 21:18:52 2016.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..')) # noqa
|
||||
|
||||
from yamllint import __copyright__, APP_NAME, APP_VERSION
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
]
|
||||
|
||||
source_suffix = '.rst'
|
||||
|
||||
master_doc = 'index'
|
||||
|
||||
project = APP_NAME
|
||||
copyright = __copyright__
|
||||
|
||||
version = APP_VERSION
|
||||
release = APP_VERSION
|
||||
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
html_theme = 'default'
|
||||
|
||||
htmlhelp_basename = 'yamllintdoc'
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'yamllint', '', [u'Adrien Vergé'], 1)
|
||||
]
|
||||
106
docs/configuration.rst
Normal file
106
docs/configuration.rst
Normal file
@@ -0,0 +1,106 @@
|
||||
Configuration
|
||||
=============
|
||||
|
||||
yamllint uses a set of :doc:`rules <rules>` to check source files for problems.
|
||||
Each rule is independent from the others, and can be enabled, disabled or
|
||||
tweaked. All these settings can be gathered in a configuration file.
|
||||
|
||||
To use a custom configuration file, use the ``-c`` option:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -c /path/to/myconfig file-to-lint.yaml
|
||||
|
||||
If ``-c`` is not provided, yamllint will look for a configuration file in the
|
||||
following locations (by order of preference):
|
||||
|
||||
- ``.yamllint`` in the current working directory
|
||||
- ``$XDG_CONFIG_HOME/yamllint/config``
|
||||
- ``~/.config/yamllint/config``
|
||||
|
||||
Finally if no config file is found, the default configuration is applied.
|
||||
|
||||
Default configuration
|
||||
---------------------
|
||||
|
||||
Unless told otherwise, yamllint uses its ``default`` configuration:
|
||||
|
||||
.. literalinclude:: ../yamllint/conf/default.yaml
|
||||
:language: yaml
|
||||
|
||||
Details on rules can be found on :doc:`the rules page <rules>`.
|
||||
|
||||
There is another pre-defined configuration named ``relaxed``. As its name
|
||||
suggests, it is more tolerant.
|
||||
|
||||
It can be chosen using:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -d relaxed file.yml
|
||||
|
||||
Extending the default configuration
|
||||
-----------------------------------
|
||||
|
||||
When writing a custom configuration file, you don't need to redefine every rule.
|
||||
Just extend the ``default`` configuration (or any already-existing configuration
|
||||
file).
|
||||
|
||||
For instance, if you just want to disable the ``comments-indentation`` rule,
|
||||
your file could look like this:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# This is my first, very own configuration file for yamllint!
|
||||
# It extends the default conf by adjusting some options.
|
||||
|
||||
extends: default
|
||||
|
||||
rules:
|
||||
comments-indentation: disable # don't bother me with this rule
|
||||
|
||||
Similarly, if you want to set the ``line-length`` rule as a warning and be less
|
||||
strict on block sequences indentation:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
extends: default
|
||||
|
||||
rules:
|
||||
# 80 chars should be enough, but don't fail if a line is longer
|
||||
line-length:
|
||||
max: 80
|
||||
level: warning
|
||||
|
||||
# accept both key:
|
||||
# - item
|
||||
#
|
||||
# and key:
|
||||
# - item
|
||||
indentation:
|
||||
indent-sequences: whatever
|
||||
|
||||
Custom configuration without a config file
|
||||
------------------------------------------
|
||||
|
||||
It is possible -- although not recommended -- to pass custom configuration
|
||||
options to yamllint with the ``-d`` (short for ``--config-data``) option.
|
||||
|
||||
Its content can either be the name of a pre-defined conf (example: ``default``
|
||||
or ``relaxed``) or a serialized YAML object describing the configuration.
|
||||
|
||||
For instance:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -d "{extends: relaxed, rules: {line-length: {max: 120}}}" file.yaml
|
||||
|
||||
Errors and warnings
|
||||
-------------------
|
||||
|
||||
Problems detected by yamllint can be raised either as errors or as warnings.
|
||||
|
||||
In both cases, the script will output them (with different colors when using the
|
||||
``standard`` output format), but the exit code can be different. More precisely,
|
||||
the script will exit will a failure code *only when* there is one or more
|
||||
error(s).
|
||||
8
docs/development.rst
Normal file
8
docs/development.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
Development
|
||||
===========
|
||||
|
||||
yamllint provides both a script and a Python module. The latter can be used to
|
||||
write your own linting tools:
|
||||
|
||||
.. automodule:: yamllint.linter
|
||||
:members:
|
||||
75
docs/disable_with_comments.rst
Normal file
75
docs/disable_with_comments.rst
Normal file
@@ -0,0 +1,75 @@
|
||||
Disable with comments
|
||||
=====================
|
||||
|
||||
Disabling checks for a specific line
|
||||
------------------------------------
|
||||
|
||||
To prevent yamllint from reporting problems for a specific line, add a directive
|
||||
comment (``# yamllint disable-line ...``) on that line, or on the line above.
|
||||
For instance:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# The following mapping contains the same key twice,
|
||||
# but I know what I'm doing:
|
||||
key: value 1
|
||||
key: value 2 # yamllint disable-line rule:key-duplicates
|
||||
|
||||
- This line is waaaaaaaaaay too long but yamllint will not report anything about it. # yamllint disable-line rule:line-length
|
||||
This line will be checked by yamllint.
|
||||
|
||||
or:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# The following mapping contains the same key twice,
|
||||
# but I know what I'm doing:
|
||||
key: value 1
|
||||
# yamllint disable-line rule:key-duplicates
|
||||
key: value 2
|
||||
|
||||
# yamllint disable-line rule:line-length
|
||||
- This line is waaaaaaaaaay too long but yamllint will not report anything about it.
|
||||
This line will be checked by yamllint.
|
||||
|
||||
It it possible, although not recommend, to disabled **all** rules for a
|
||||
specific line:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# yamllint disable-line
|
||||
- { all : rules ,are disabled for this line}
|
||||
|
||||
If you need to disable multiple rules, it is allowed to chain rules like this:
|
||||
``# yamllint disable-line rule:hyphens rule:commas rule:indentation``.
|
||||
|
||||
Disabling checks for all (or part of) the file
|
||||
----------------------------------------------
|
||||
|
||||
To prevent yamllint from reporting problems for the whoe file, or for a block of
|
||||
lines within the file, use ``# yamllint disable ...`` and ``# yamllint enable
|
||||
...`` directive comments. For instance:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# yamllint disable rule:colons
|
||||
- Lorem : ipsum
|
||||
dolor : sit amet,
|
||||
consectetur : adipiscing elit
|
||||
# yamllint enable rule:colons
|
||||
|
||||
- rest of the document...
|
||||
|
||||
It it possible, although not recommend, to disabled **all** rules:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# yamllint disable
|
||||
- Lorem :
|
||||
ipsum:
|
||||
dolor : [ sit,amet]
|
||||
- consectetur : adipiscing elit
|
||||
# yamllint enable
|
||||
|
||||
If you need to disable multiple rules, it is allowed to chain rules like this:
|
||||
``# yamllint disable rule:hyphens rule:commas rule:indentation``.
|
||||
28
docs/index.rst
Normal file
28
docs/index.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
yamllint documentation
|
||||
======================
|
||||
|
||||
.. automodule:: yamllint
|
||||
|
||||
Screenshot
|
||||
----------
|
||||
|
||||
.. image:: screenshot.png
|
||||
:alt: yamllint screenshot
|
||||
|
||||
.. note::
|
||||
|
||||
The default output format is inspired by `eslint <http://eslint.org/>`_, a
|
||||
great linting tool for Javascript.
|
||||
|
||||
Table of contents
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
quickstart
|
||||
configuration
|
||||
rules
|
||||
disable_with_comments
|
||||
development
|
||||
text_editors
|
||||
93
docs/quickstart.rst
Normal file
93
docs/quickstart.rst
Normal file
@@ -0,0 +1,93 @@
|
||||
Quickstart
|
||||
==========
|
||||
|
||||
Installing yamllint
|
||||
-------------------
|
||||
|
||||
On Fedora / CentOS:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo dnf install yamllint
|
||||
|
||||
On Debian 9+ / Ubuntu 16.04+:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo apt-get install yamllint
|
||||
|
||||
On older Debian / Ubuntu versions:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
|
||||
sudo apt-get install yamllint
|
||||
|
||||
Alternatively using pip, the Python package manager:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo pip install yamllint
|
||||
|
||||
If you prefer installing from source, you can run, from the source directory:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
python setup.py sdist
|
||||
sudo pip install dist/yamllint-*.tar.gz
|
||||
|
||||
Running yamllint
|
||||
----------------
|
||||
|
||||
Basic usage:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint file.yml other-file.yaml
|
||||
|
||||
You can also lint all YAML files in a whole directory:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint .
|
||||
|
||||
The output will look like (colors are not displayed here):
|
||||
|
||||
::
|
||||
|
||||
file.yml
|
||||
1:4 error trailing spaces (trailing-spaces)
|
||||
4:4 error wrong indentation: expected 4 but found 3 (indentation)
|
||||
5:4 error duplication of key "id-00042" in mapping (key-duplicates)
|
||||
6:6 warning comment not indented like content (comments-indentation)
|
||||
12:6 error too many spaces after hyphen (hyphens)
|
||||
15:12 error too many spaces before comma (commas)
|
||||
|
||||
other-file.yaml
|
||||
1:1 warning missing document start "---" (document-start)
|
||||
6:81 error line too long (87 > 80 characters) (line-length)
|
||||
10:1 error too many blank lines (4 > 2) (empty-lines)
|
||||
11:4 error too many spaces inside braces (braces)
|
||||
|
||||
Add the ``-f parsable`` arguments if you need an output format parsable by a
|
||||
machine (for instance for :doc:`syntax highlighting in text editors
|
||||
<text_editors>`). The output will then look like:
|
||||
|
||||
::
|
||||
|
||||
file.yml:6:2: [warning] missing starting space in comment (comments)
|
||||
file.yml:57:1: [error] trailing spaces (trailing-spaces)
|
||||
file.yml:60:3: [error] wrong indentation: expected 4 but found 2 (indentation)
|
||||
|
||||
If you have a custom linting configuration file (see :doc:`how to configure
|
||||
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
|
||||
option:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -c ~/myconfig file.yaml
|
||||
|
||||
.. note::
|
||||
|
||||
If you have a ``.yamllint`` file in your working directory, it will be
|
||||
automatically loaded as configuration by yamllint.
|
||||
95
docs/rules.rst
Normal file
95
docs/rules.rst
Normal file
@@ -0,0 +1,95 @@
|
||||
Rules
|
||||
=====
|
||||
|
||||
When linting a document with yamllint, a series of rules (such as
|
||||
``line-length``, ``trailing-spaces``, etc.) are checked against.
|
||||
|
||||
A :doc:`configuration file <configuration>` can be used to enable or disable
|
||||
these rules, to set their level (*error* or *warning*), but also to tweak their
|
||||
options.
|
||||
|
||||
This page describes the rules and their options.
|
||||
|
||||
.. contents:: List of rules
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
braces
|
||||
------
|
||||
|
||||
.. automodule:: yamllint.rules.braces
|
||||
|
||||
brackets
|
||||
--------
|
||||
|
||||
.. automodule:: yamllint.rules.brackets
|
||||
|
||||
colons
|
||||
------
|
||||
|
||||
.. automodule:: yamllint.rules.colons
|
||||
|
||||
commas
|
||||
------
|
||||
|
||||
.. automodule:: yamllint.rules.commas
|
||||
|
||||
comments
|
||||
--------
|
||||
|
||||
.. automodule:: yamllint.rules.comments
|
||||
|
||||
comments-indentation
|
||||
--------------------
|
||||
|
||||
.. automodule:: yamllint.rules.comments_indentation
|
||||
|
||||
document-end
|
||||
------------
|
||||
|
||||
.. automodule:: yamllint.rules.document_end
|
||||
|
||||
document-start
|
||||
--------------
|
||||
|
||||
.. automodule:: yamllint.rules.document_start
|
||||
|
||||
empty-lines
|
||||
-----------
|
||||
|
||||
.. automodule:: yamllint.rules.empty_lines
|
||||
|
||||
hyphens
|
||||
-------
|
||||
|
||||
.. automodule:: yamllint.rules.hyphens
|
||||
|
||||
indentation
|
||||
-----------
|
||||
|
||||
.. automodule:: yamllint.rules.indentation
|
||||
|
||||
key-duplicates
|
||||
--------------
|
||||
|
||||
.. automodule:: yamllint.rules.key_duplicates
|
||||
|
||||
line-length
|
||||
-----------
|
||||
|
||||
.. automodule:: yamllint.rules.line_length
|
||||
|
||||
new-line-at-end-of-file
|
||||
-----------------------
|
||||
|
||||
.. automodule:: yamllint.rules.new_line_at_end_of_file
|
||||
|
||||
new-lines
|
||||
---------
|
||||
|
||||
.. automodule:: yamllint.rules.new_lines
|
||||
|
||||
trailing-spaces
|
||||
---------------
|
||||
|
||||
.. automodule:: yamllint.rules.trailing_spaces
|
||||
BIN
docs/screenshot.png
Normal file
BIN
docs/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
32
docs/text_editors.rst
Normal file
32
docs/text_editors.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
Integration with text editors
|
||||
=============================
|
||||
|
||||
Most text editors support syntax checking and highlighting, to visually report
|
||||
syntax errors and warnings to the user. yamllint can be used to syntax-check
|
||||
YAML source, but a bit of configuration is required depending on your favorite
|
||||
text editor.
|
||||
|
||||
Vim
|
||||
---
|
||||
|
||||
Assuming that the `syntastic <https://github.com/scrooloose/syntastic>`_ plugin
|
||||
is installed, add to your ``.vimrc``:
|
||||
|
||||
::
|
||||
|
||||
let g:syntastic_yaml_checkers = ['yamllint']
|
||||
|
||||
Neovim
|
||||
------
|
||||
|
||||
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
||||
installed, yamllint is supported by default. It is automatically enabled when
|
||||
editing YAML files.
|
||||
|
||||
Other text editors
|
||||
------------------
|
||||
|
||||
.. rubric:: Help wanted!
|
||||
|
||||
Your favorite text editor is not listed here? Help us improve by adding a
|
||||
section (by opening a pull-request or issue on GitHub).
|
||||
12
setup.py
12
setup.py
@@ -24,12 +24,13 @@ setup(
|
||||
name=APP_NAME,
|
||||
version=APP_VERSION,
|
||||
author=__author__,
|
||||
description=APP_DESCRIPTION,
|
||||
description=APP_DESCRIPTION.split('\n')[0],
|
||||
long_description=APP_DESCRIPTION,
|
||||
license=__license__,
|
||||
keywords=['yaml', 'lint', 'linter'],
|
||||
keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
|
||||
url='https://github.com/adrienverge/yamllint',
|
||||
classifiers=[
|
||||
'Development Status :: 4 - Beta',
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Environment :: Console',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
|
||||
@@ -42,8 +43,9 @@ setup(
|
||||
],
|
||||
|
||||
packages=find_packages(),
|
||||
scripts=['bin/yamllint'],
|
||||
package_data={'yamllint': ['conf/*.yml']},
|
||||
entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
|
||||
package_data={'yamllint': ['conf/*.yaml'],
|
||||
'tests': ['yaml-1.2-spec-examples/*']},
|
||||
install_requires=['pyyaml'],
|
||||
tests_require=['nose'],
|
||||
test_suite='nose.collector',
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import locale
|
||||
|
||||
|
||||
locale.setlocale(locale.LC_ALL, 'C')
|
||||
|
||||
@@ -18,9 +18,8 @@ import unittest
|
||||
|
||||
import yaml
|
||||
|
||||
from yamllint.config import parse_config
|
||||
from yamllint.errors import LintProblem
|
||||
from yamllint import lint
|
||||
from yamllint.config import YamlLintConfig
|
||||
from yamllint import linter
|
||||
|
||||
|
||||
class RuleTestCase(unittest.TestCase):
|
||||
@@ -31,15 +30,22 @@ class RuleTestCase(unittest.TestCase):
|
||||
conf = yaml.safe_load(conf)
|
||||
conf = {'extends': 'default',
|
||||
'rules': conf}
|
||||
return parse_config(yaml.safe_dump(conf))
|
||||
return YamlLintConfig(yaml.safe_dump(conf))
|
||||
|
||||
def check(self, source, conf, line=None, column=None, **kwargs):
|
||||
def check(self, source, conf, **kwargs):
|
||||
expected_problems = []
|
||||
for key in kwargs:
|
||||
assert key.startswith('problem')
|
||||
expected_problems.append(
|
||||
LintProblem(kwargs[key][0], kwargs[key][1], rule=self.rule_id))
|
||||
if len(kwargs[key]) > 2:
|
||||
if kwargs[key][2] == 'syntax':
|
||||
rule_id = None
|
||||
else:
|
||||
rule_id = kwargs[key][2]
|
||||
else:
|
||||
rule_id = self.rule_id
|
||||
expected_problems.append(linter.LintProblem(
|
||||
kwargs[key][0], kwargs[key][1], rule=rule_id))
|
||||
expected_problems.sort()
|
||||
|
||||
real_problems = list(lint(source, self.build_fake_config(conf)))
|
||||
real_problems = list(linter.run(source, self.build_fake_config(conf)))
|
||||
self.assertEqual(real_problems, expected_problems)
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class ColonTestCase(RuleTestCase):
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class ColonTestCase(RuleTestCase):
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class ColonTestCase(RuleTestCase):
|
||||
@@ -118,7 +118,7 @@ class ColonTestCase(RuleTestCase):
|
||||
'...\n', conf, problem=(3, 8))
|
||||
|
||||
def test_before_with_explicit_block_mappings(self):
|
||||
conf = 'colons: {max-spaces-before: 0, max-spaces-after: -1}'
|
||||
conf = 'colons: {max-spaces-before: 0, max-spaces-after: 1}'
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ? key\n'
|
||||
@@ -129,6 +129,30 @@ class ColonTestCase(RuleTestCase):
|
||||
' ? key\n'
|
||||
' : value\n'
|
||||
'...\n', conf, problem=(2, 7))
|
||||
self.check('---\n'
|
||||
'? >\n'
|
||||
' multi-line\n'
|
||||
' key\n'
|
||||
': >\n'
|
||||
' multi-line\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'- ? >\n'
|
||||
' multi-line\n'
|
||||
' key\n'
|
||||
' : >\n'
|
||||
' multi-line\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'- ? >\n'
|
||||
' multi-line\n'
|
||||
' key\n'
|
||||
' : >\n'
|
||||
' multi-line\n'
|
||||
' value\n'
|
||||
'...\n', conf, problem=(5, 5))
|
||||
|
||||
def test_after_enabled(self):
|
||||
conf = 'colons: {max-spaces-before: -1, max-spaces-after: 1}'
|
||||
@@ -152,6 +176,21 @@ class ColonTestCase(RuleTestCase):
|
||||
'a: {b: {c: d, e : f}}\n', conf,
|
||||
problem1=(2, 12), problem2=(2, 20))
|
||||
|
||||
def test_after_enabled_question_mark(self):
|
||||
conf = 'colons: {max-spaces-before: -1, max-spaces-after: 1}'
|
||||
self.check('---\n'
|
||||
'? key\n'
|
||||
': value\n', conf)
|
||||
self.check('---\n'
|
||||
'? key\n'
|
||||
': value\n', conf, problem=(2, 3))
|
||||
self.check('---\n'
|
||||
'? key\n'
|
||||
': value\n', conf, problem1=(2, 3), problem2=(3, 3))
|
||||
self.check('---\n'
|
||||
'- ? key\n'
|
||||
' : value\n', conf, problem1=(2, 5), problem2=(3, 5))
|
||||
|
||||
def test_after_max(self):
|
||||
conf = 'colons: {max-spaces-before: -1, max-spaces-after: 3}'
|
||||
self.check('---\n'
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class CommaTestCase(RuleTestCase):
|
||||
@@ -33,9 +33,25 @@ class CommaTestCase(RuleTestCase):
|
||||
' key2: val2,\n'
|
||||
'}\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'- [one, two , three,four]\n'
|
||||
'- {five,six , seven, eight}\n'
|
||||
'- [\n'
|
||||
' nine, ten\n'
|
||||
' , eleven\n'
|
||||
' ,twelve\n'
|
||||
']\n'
|
||||
'- {\n'
|
||||
' thirteen: 13, fourteen\n'
|
||||
' , fifteen: 15\n'
|
||||
' ,sixteen: 16\n'
|
||||
'}\n', conf)
|
||||
|
||||
def test_before_enabled(self):
|
||||
conf = 'commas: {max-spaces-before: 0, max-spaces-after: -1}'
|
||||
def test_before_max(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' min-spaces-after: 0\n'
|
||||
' max-spaces-after: -1\n')
|
||||
self.check('---\n'
|
||||
'array: [1, 2, 3, 4]\n'
|
||||
'...\n', conf)
|
||||
@@ -75,8 +91,51 @@ class CommaTestCase(RuleTestCase):
|
||||
' key2: val2 ,\n'
|
||||
'}\n', conf, problem=(4, 13))
|
||||
|
||||
def test_before_max(self):
|
||||
conf = 'commas: {max-spaces-before: 3, max-spaces-after: -1}'
|
||||
def test_before_max_with_comma_on_new_line(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' min-spaces-after: 0\n'
|
||||
' max-spaces-after: -1\n')
|
||||
self.check('---\n'
|
||||
'flow-seq: [1, 2, 3\n'
|
||||
' , 4, 5, 6]\n'
|
||||
'...\n', conf, problem=(3, 11))
|
||||
self.check('---\n'
|
||||
'flow-map: {a: 1, b: 2\n'
|
||||
' , c: 3}\n'
|
||||
'...\n', conf, problem=(3, 11))
|
||||
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' min-spaces-after: 0\n'
|
||||
' max-spaces-after: -1\n'
|
||||
'indentation: disable\n')
|
||||
self.check('---\n'
|
||||
'flow-seq: [1, 2, 3\n'
|
||||
' , 4, 5, 6]\n'
|
||||
'...\n', conf, problem=(3, 9))
|
||||
self.check('---\n'
|
||||
'flow-map: {a: 1, b: 2\n'
|
||||
' , c: 3}\n'
|
||||
'...\n', conf, problem=(3, 9))
|
||||
self.check('---\n'
|
||||
'[\n'
|
||||
'1,\n'
|
||||
'2\n'
|
||||
', 3\n'
|
||||
']\n', conf, problem=(5, 1))
|
||||
self.check('---\n'
|
||||
'{\n'
|
||||
'a: 1,\n'
|
||||
'b: 2\n'
|
||||
', c: 3\n'
|
||||
'}\n', conf, problem=(5, 1))
|
||||
|
||||
def test_before_max_3(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 3\n'
|
||||
' min-spaces-after: 0\n'
|
||||
' max-spaces-after: -1\n')
|
||||
self.check('---\n'
|
||||
'array: [1 , 2, 3 , 4]\n'
|
||||
'...\n', conf)
|
||||
@@ -90,8 +149,32 @@ class CommaTestCase(RuleTestCase):
|
||||
' key: val,\n'
|
||||
']\n', conf, problem=(4, 11))
|
||||
|
||||
def test_after_enabled(self):
|
||||
conf = 'commas: {max-spaces-before: -1, max-spaces-after: 1}'
|
||||
def test_after_min(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: -1\n'
|
||||
' min-spaces-after: 1\n'
|
||||
' max-spaces-after: -1\n')
|
||||
self.check('---\n'
|
||||
'- [one, two , three,four]\n'
|
||||
'- {five,six , seven, eight}\n'
|
||||
'- [\n'
|
||||
' nine, ten\n'
|
||||
' , eleven\n'
|
||||
' ,twelve\n'
|
||||
']\n'
|
||||
'- {\n'
|
||||
' thirteen: 13, fourteen\n'
|
||||
' , fifteen: 15\n'
|
||||
' ,sixteen: 16\n'
|
||||
'}\n', conf,
|
||||
problem1=(2, 21), problem2=(3, 9),
|
||||
problem3=(7, 4), problem4=(12, 4))
|
||||
|
||||
def test_after_max(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: -1\n'
|
||||
' min-spaces-after: 0\n'
|
||||
' max-spaces-after: 1\n')
|
||||
self.check('---\n'
|
||||
'array: [1, 2, 3, 4]\n'
|
||||
'...\n', conf)
|
||||
@@ -124,8 +207,11 @@ class CommaTestCase(RuleTestCase):
|
||||
' key1: val1, key2: [val2, val3]\n'
|
||||
'}\n', conf, problem1=(3, 16), problem2=(3, 30))
|
||||
|
||||
def test_after_max(self):
|
||||
conf = 'commas: {max-spaces-before: -1, max-spaces-after: 3}'
|
||||
def test_after_max_3(self):
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: -1\n'
|
||||
' min-spaces-after: 1\n'
|
||||
' max-spaces-after: 3\n')
|
||||
self.check('---\n'
|
||||
'array: [1, 2, 3, 4]\n'
|
||||
'...\n', conf)
|
||||
@@ -137,7 +223,10 @@ class CommaTestCase(RuleTestCase):
|
||||
'...\n', conf, problem1=(2, 31), problem2=(2, 49))
|
||||
|
||||
def test_both_before_and_after(self):
|
||||
conf = 'commas: {max-spaces-before: 0, max-spaces-after: 1}'
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' min-spaces-after: 1\n'
|
||||
' max-spaces-after: 1\n')
|
||||
self.check('---\n'
|
||||
'dict: {a: b , c: "1 2 3", d: e , f: [g, h]}\n'
|
||||
'array: [\n'
|
||||
@@ -152,3 +241,25 @@ class CommaTestCase(RuleTestCase):
|
||||
problem1=(2, 12), problem2=(2, 16), problem3=(2, 31),
|
||||
problem4=(2, 36), problem5=(2, 50), problem6=(4, 8),
|
||||
problem7=(5, 11), problem8=(8, 13))
|
||||
conf = ('commas:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' min-spaces-after: 1\n'
|
||||
' max-spaces-after: 1\n'
|
||||
'indentation: disable\n')
|
||||
self.check('---\n'
|
||||
'- [one, two , three,four]\n'
|
||||
'- {five,six , seven, eight}\n'
|
||||
'- [\n'
|
||||
' nine, ten\n'
|
||||
' , eleven\n'
|
||||
' ,twelve\n'
|
||||
']\n'
|
||||
'- {\n'
|
||||
' thirteen: 13, fourteen\n'
|
||||
' , fifteen: 15\n'
|
||||
' ,sixteen: 16\n'
|
||||
'}\n', conf,
|
||||
problem1=(2, 12), problem2=(2, 21), problem3=(3, 9),
|
||||
problem4=(3, 12), problem5=(5, 9), problem6=(6, 2),
|
||||
problem7=(7, 2), problem8=(7, 4), problem9=(10, 17),
|
||||
problem10=(11, 2), problem11=(12, 2), problem12=(12, 4))
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class CommentsTestCase(RuleTestCase):
|
||||
@@ -131,3 +131,19 @@ class CommentsTestCase(RuleTestCase):
|
||||
' require-starting-space: yes\n'
|
||||
' min-spaces-from-content: 2\n')
|
||||
self.check('# comment\n', conf)
|
||||
|
||||
def test_multi_line_scalar(self):
|
||||
conf = ('comments:\n'
|
||||
' require-starting-space: yes\n'
|
||||
' min-spaces-from-content: 2\n'
|
||||
'trailing-spaces: disable\n')
|
||||
self.check('---\n'
|
||||
'string: >\n'
|
||||
' this is plain text\n'
|
||||
'\n'
|
||||
'# comment\n', conf)
|
||||
self.check('---\n'
|
||||
'- string: >\n'
|
||||
' this is plain text\n'
|
||||
' \n'
|
||||
' # comment\n', conf)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class CommentsIndentationTestCase(RuleTestCase):
|
||||
@@ -49,7 +49,7 @@ class CommentsIndentationTestCase(RuleTestCase):
|
||||
'...\n', conf)
|
||||
|
||||
def test_enabled(self):
|
||||
conf = 'comments-indentation: {}'
|
||||
conf = 'comments-indentation: enable'
|
||||
self.check('---\n'
|
||||
'# line 1\n'
|
||||
'# line 2\n', conf)
|
||||
@@ -58,7 +58,7 @@ class CommentsIndentationTestCase(RuleTestCase):
|
||||
'# line 2\n', conf, problem=(2, 2))
|
||||
self.check('---\n'
|
||||
' # line 1\n'
|
||||
' # line 2\n', conf, problem1=(2, 3), problem2=(3, 3))
|
||||
' # line 2\n', conf, problem1=(2, 3))
|
||||
self.check('---\n'
|
||||
'obj:\n'
|
||||
' # normal\n'
|
||||
@@ -88,29 +88,53 @@ class CommentsIndentationTestCase(RuleTestCase):
|
||||
self.check('---\n'
|
||||
'obj1:\n'
|
||||
' a: 1\n'
|
||||
' # comments\n'
|
||||
' # the following line is disabled\n'
|
||||
' # b: 2\n', conf)
|
||||
self.check('---\n'
|
||||
'obj1:\n'
|
||||
' a: 1\n'
|
||||
' # b: 2\n'
|
||||
'\n'
|
||||
'obj2:\n'
|
||||
' b: 2\n', conf, problem=(4, 3))
|
||||
' b: 2\n', conf)
|
||||
self.check('---\n'
|
||||
'obj1:\n'
|
||||
' a: 1\n'
|
||||
' # b: 2\n'
|
||||
'# this object is useless\n'
|
||||
'obj2: no\n', conf)
|
||||
self.check('---\n'
|
||||
'obj1:\n'
|
||||
' a: 1\n'
|
||||
'# this object is useless\n'
|
||||
' # b: 2\n'
|
||||
'obj2: no\n', conf, problem=(5, 3))
|
||||
self.check('---\n'
|
||||
'obj1:\n'
|
||||
' a: 1\n'
|
||||
' # comments\n'
|
||||
' b: 2\n', conf)
|
||||
self.check('---\n'
|
||||
'my list for today:\n'
|
||||
' - todo 1\n'
|
||||
' - todo 2\n'
|
||||
' # commented for now\n'
|
||||
' # - todo 3\n'
|
||||
'...\n', conf)
|
||||
|
||||
def test_first_line(self):
|
||||
conf = 'comments-indentation: {}'
|
||||
conf = 'comments-indentation: enable'
|
||||
self.check('# comment\n', conf)
|
||||
self.check(' # comment\n', conf, problem=(1, 3))
|
||||
|
||||
def test_no_newline_at_end(self):
|
||||
conf = ('comments-indentation: {}\n'
|
||||
conf = ('comments-indentation: enable\n'
|
||||
'new-line-at-end-of-file: disable\n')
|
||||
self.check('# comment', conf)
|
||||
self.check(' # comment', conf, problem=(1, 3))
|
||||
|
||||
def test_empty_comment(self):
|
||||
conf = 'comments-indentation: {}'
|
||||
conf = 'comments-indentation: enable'
|
||||
self.check('---\n'
|
||||
'# hey\n'
|
||||
'# normal\n'
|
||||
@@ -119,3 +143,15 @@ class CommentsIndentationTestCase(RuleTestCase):
|
||||
'# hey\n'
|
||||
'# normal\n'
|
||||
' #\n', conf, problem=(4, 2))
|
||||
|
||||
def test_inline_comment(self):
|
||||
conf = 'comments-indentation: enable'
|
||||
self.check('---\n'
|
||||
'- a # inline\n'
|
||||
'# ok\n', conf)
|
||||
self.check('---\n'
|
||||
'- a # inline\n'
|
||||
' # not ok\n', conf, problem=(3, 2))
|
||||
self.check('---\n'
|
||||
' # not ok\n'
|
||||
'- a # inline\n', conf, problem=(2, 2))
|
||||
|
||||
@@ -18,57 +18,27 @@ import unittest
|
||||
|
||||
import yaml
|
||||
|
||||
from yamllint.rules.common import Comment, get_comments_between_tokens
|
||||
from yamllint.rules.common import get_line_indent
|
||||
|
||||
|
||||
class CommonTestCase(unittest.TestCase):
|
||||
def check_comments(self, buffer, *expected):
|
||||
yaml_loader = yaml.BaseLoader(buffer)
|
||||
def test_get_line_indent(self):
|
||||
tokens = list(yaml.scan('a: 1\n'
|
||||
'b:\n'
|
||||
' - c: [2, 3, {d: 4}]\n'))
|
||||
|
||||
comments = []
|
||||
self.assertEqual(tokens[3].value, 'a')
|
||||
self.assertEqual(tokens[5].value, '1')
|
||||
self.assertEqual(tokens[7].value, 'b')
|
||||
self.assertEqual(tokens[13].value, 'c')
|
||||
self.assertEqual(tokens[16].value, '2')
|
||||
self.assertEqual(tokens[18].value, '3')
|
||||
self.assertEqual(tokens[22].value, 'd')
|
||||
self.assertEqual(tokens[24].value, '4')
|
||||
|
||||
next = yaml_loader.peek_token()
|
||||
while next is not None:
|
||||
curr = yaml_loader.get_token()
|
||||
next = yaml_loader.peek_token()
|
||||
for comment in get_comments_between_tokens(curr, next):
|
||||
comments.append(comment)
|
||||
|
||||
self.assertEqual(comments, list(expected))
|
||||
|
||||
def test_get_comments_between_tokens(self):
|
||||
self.check_comments('# comment\n',
|
||||
Comment(1, 1, '# comment', 0))
|
||||
self.check_comments('---\n'
|
||||
'# comment\n'
|
||||
'...\n',
|
||||
Comment(2, 1, '# comment', 0))
|
||||
self.check_comments('---\n'
|
||||
'# no newline char',
|
||||
Comment(2, 1, '# no newline char', 0))
|
||||
self.check_comments('# just comment',
|
||||
Comment(1, 1, '# just comment', 0))
|
||||
self.check_comments('\n'
|
||||
' # indented comment\n',
|
||||
Comment(2, 4, '# indented comment', 0))
|
||||
self.check_comments('\n'
|
||||
'# trailing spaces \n',
|
||||
Comment(2, 1, '# trailing spaces ', 0))
|
||||
self.check_comments('# comment one\n'
|
||||
'\n'
|
||||
'key: val # key=val\n'
|
||||
'\n'
|
||||
'# this is\n'
|
||||
'# a block \n'
|
||||
'# comment\n'
|
||||
'\n'
|
||||
'other:\n'
|
||||
' - foo # equals\n'
|
||||
' # bar\n',
|
||||
Comment(1, 1, '# comment one', 0),
|
||||
Comment(3, 11, '# key=val', 0),
|
||||
Comment(5, 1, '# this is', 0),
|
||||
Comment(6, 1, '# a block ', 0),
|
||||
Comment(7, 1, '# comment', 0),
|
||||
Comment(10, 10, '# equals', 0),
|
||||
Comment(11, 10, '# bar', 0))
|
||||
for i in (3, 5):
|
||||
self.assertEqual(get_line_indent(tokens[i]), 0)
|
||||
for i in (7,):
|
||||
self.assertEqual(get_line_indent(tokens[i]), 0)
|
||||
for i in (13, 16, 18, 22, 24):
|
||||
self.assertEqual(get_line_indent(tokens[i]), 2)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class DocumentEndTestCase(RuleTestCase):
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class DocumentStartTestCase(RuleTestCase):
|
||||
@@ -82,7 +82,7 @@ class DocumentStartTestCase(RuleTestCase):
|
||||
'...\n'
|
||||
'second: document\n'
|
||||
'---\n'
|
||||
'third: document\n', conf, problem=(4, 1))
|
||||
'third: document\n', conf, problem=(4, 1, 'syntax'))
|
||||
|
||||
def test_directives(self):
|
||||
conf = 'document-start: {present: yes}'
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class EmptyLinesTestCase(RuleTestCase):
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class HyphenTestCase(RuleTestCase):
|
||||
@@ -70,11 +70,11 @@ class HyphenTestCase(RuleTestCase):
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' - elem1\n'
|
||||
'- elem2\n', conf, problem=(4, 3))
|
||||
' - elem2\n', conf, problem=(4, 5))
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' - elem1\n'
|
||||
'- elem2\n', conf, problem1=(3, 3), problem2=(4, 3))
|
||||
' - elem2\n', conf, problem1=(3, 5), problem2=(4, 5))
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' subobject:\n'
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
156
tests/rules/test_key_duplicates.py
Normal file
156
tests/rules/test_key_duplicates.py
Normal file
@@ -0,0 +1,156 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class KeyDuplicatesTestCase(RuleTestCase):
|
||||
rule_id = 'key-duplicates'
|
||||
|
||||
def test_disabled(self):
|
||||
conf = 'key-duplicates: disable'
|
||||
self.check('---\n'
|
||||
'block mapping:\n'
|
||||
' key: a\n'
|
||||
' otherkey: b\n'
|
||||
' key: c\n', conf)
|
||||
self.check('---\n'
|
||||
'flow mapping:\n'
|
||||
' {key: a, otherkey: b, key: c}\n', conf)
|
||||
self.check('---\n'
|
||||
'duplicated twice:\n'
|
||||
' - k: a\n'
|
||||
' ok: b\n'
|
||||
' k: c\n'
|
||||
' k: d\n', conf)
|
||||
self.check('---\n'
|
||||
'duplicated twice:\n'
|
||||
' - {k: a, ok: b, k: c, k: d}\n', conf)
|
||||
self.check('---\n'
|
||||
'multiple duplicates:\n'
|
||||
' a: 1\n'
|
||||
' b: 2\n'
|
||||
' c: 3\n'
|
||||
' d: 4\n'
|
||||
' d: 5\n'
|
||||
' b: 6\n', conf)
|
||||
self.check('---\n'
|
||||
'multiple duplicates:\n'
|
||||
' {a: 1, b: 2, c: 3, d: 4, d: 5, b: 6}\n', conf)
|
||||
self.check('---\n'
|
||||
'at: root\n'
|
||||
'multiple: times\n'
|
||||
'at: root\n', conf)
|
||||
self.check('---\n'
|
||||
'nested but OK:\n'
|
||||
' a: {a: {a: 1}}\n'
|
||||
' b:\n'
|
||||
' b: 2\n'
|
||||
' c: 3\n', conf)
|
||||
self.check('---\n'
|
||||
'nested duplicates:\n'
|
||||
' a: {a: 1, a: 1}\n'
|
||||
' b:\n'
|
||||
' c: 3\n'
|
||||
' d: 4\n'
|
||||
' d: 4\n'
|
||||
' b: 2\n', conf)
|
||||
self.check('---\n'
|
||||
'duplicates with many styles: 1\n'
|
||||
'"duplicates with many styles": 1\n'
|
||||
'\'duplicates with many styles\': 1\n'
|
||||
'? duplicates with many styles\n'
|
||||
': 1\n'
|
||||
'? >-\n'
|
||||
' duplicates with\n'
|
||||
' many styles\n'
|
||||
': 1\n', conf)
|
||||
|
||||
def test_enabled(self):
|
||||
conf = 'key-duplicates: enable'
|
||||
self.check('---\n'
|
||||
'block mapping:\n'
|
||||
' key: a\n'
|
||||
' otherkey: b\n'
|
||||
' key: c\n', conf,
|
||||
problem=(5, 3))
|
||||
self.check('---\n'
|
||||
'flow mapping:\n'
|
||||
' {key: a, otherkey: b, key: c}\n', conf,
|
||||
problem=(3, 25))
|
||||
self.check('---\n'
|
||||
'duplicated twice:\n'
|
||||
' - k: a\n'
|
||||
' ok: b\n'
|
||||
' k: c\n'
|
||||
' k: d\n', conf,
|
||||
problem1=(5, 5), problem2=(6, 5))
|
||||
self.check('---\n'
|
||||
'duplicated twice:\n'
|
||||
' - {k: a, ok: b, k: c, k: d}\n', conf,
|
||||
problem1=(3, 19), problem2=(3, 25))
|
||||
self.check('---\n'
|
||||
'multiple duplicates:\n'
|
||||
' a: 1\n'
|
||||
' b: 2\n'
|
||||
' c: 3\n'
|
||||
' d: 4\n'
|
||||
' d: 5\n'
|
||||
' b: 6\n', conf,
|
||||
problem1=(7, 3), problem2=(8, 3))
|
||||
self.check('---\n'
|
||||
'multiple duplicates:\n'
|
||||
' {a: 1, b: 2, c: 3, d: 4, d: 5, b: 6}\n', conf,
|
||||
problem1=(3, 28), problem2=(3, 34))
|
||||
self.check('---\n'
|
||||
'at: root\n'
|
||||
'multiple: times\n'
|
||||
'at: root\n', conf,
|
||||
problem=(4, 1))
|
||||
self.check('---\n'
|
||||
'nested but OK:\n'
|
||||
' a: {a: {a: 1}}\n'
|
||||
' b:\n'
|
||||
' b: 2\n'
|
||||
' c: 3\n', conf)
|
||||
self.check('---\n'
|
||||
'nested duplicates:\n'
|
||||
' a: {a: 1, a: 1}\n'
|
||||
' b:\n'
|
||||
' c: 3\n'
|
||||
' d: 4\n'
|
||||
' d: 4\n'
|
||||
' b: 2\n', conf,
|
||||
problem1=(3, 13), problem2=(7, 5), problem3=(8, 3))
|
||||
self.check('---\n'
|
||||
'duplicates with many styles: 1\n'
|
||||
'"duplicates with many styles": 1\n'
|
||||
'\'duplicates with many styles\': 1\n'
|
||||
'? duplicates with many styles\n'
|
||||
': 1\n'
|
||||
'? >-\n'
|
||||
' duplicates with\n'
|
||||
' many styles\n'
|
||||
': 1\n', conf,
|
||||
problem1=(3, 1), problem2=(4, 1), problem3=(5, 3),
|
||||
problem4=(7, 3))
|
||||
|
||||
def test_key_tokens_in_flow_sequences(self):
|
||||
conf = 'key-duplicates: enable'
|
||||
self.check('---\n'
|
||||
'[\n'
|
||||
' flow: sequence, with, key: value, mappings\n'
|
||||
']\n', conf)
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class LineLengthTestCase(RuleTestCase):
|
||||
@@ -43,17 +43,17 @@ class LineLengthTestCase(RuleTestCase):
|
||||
self.check('---\n', conf)
|
||||
self.check(80 * 'a', conf)
|
||||
self.check('---\n' + 80 * 'a' + '\n', conf)
|
||||
self.check(81 * 'a', conf, problem=(1, 81))
|
||||
self.check('---\n' + 81 * 'a' + '\n', conf, problem=(2, 81))
|
||||
self.check(1000 * 'b', conf, problem=(1, 81))
|
||||
self.check('---\n' + 1000 * 'b' + '\n', conf, problem=(2, 81))
|
||||
self.check(16 * 'aaaa ' + 'z', conf, problem=(1, 81))
|
||||
self.check('---\n' + 16 * 'aaaa ' + 'z' + '\n', conf, problem=(2, 81))
|
||||
self.check(1000 * 'word ' + 'end', conf, problem=(1, 81))
|
||||
self.check('---\n' + 1000 * 'word ' + 'end\n', conf, problem=(2, 81))
|
||||
|
||||
def test_max_length_10(self):
|
||||
conf = ('line-length: {max: 10}\n'
|
||||
'new-line-at-end-of-file: disable\n')
|
||||
self.check('---\nABCDEFGHIJ', conf)
|
||||
self.check('---\nABCDEFGHIJK', conf, problem=(2, 11))
|
||||
self.check('---\nABCDEFGHIJK\n', conf, problem=(2, 11))
|
||||
self.check('---\nABCD EFGHI', conf)
|
||||
self.check('---\nABCD EFGHIJ', conf, problem=(2, 11))
|
||||
self.check('---\nABCD EFGHIJ\n', conf, problem=(2, 11))
|
||||
|
||||
def test_spaces(self):
|
||||
conf = ('line-length: {max: 80}\n'
|
||||
@@ -61,3 +61,48 @@ class LineLengthTestCase(RuleTestCase):
|
||||
'trailing-spaces: disable\n')
|
||||
self.check('---\n' + 81 * ' ', conf, problem=(2, 81))
|
||||
self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81))
|
||||
|
||||
def test_non_breakable_word(self):
|
||||
conf = 'line-length: {max: 20, allow-non-breakable-words: yes}'
|
||||
self.check('---\n' + 30 * 'A' + '\n', conf)
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
' is:\n'
|
||||
' - a:\n'
|
||||
' http://localhost/very/long/url\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
' is:\n'
|
||||
' - a:\n'
|
||||
' # http://localhost/very/long/url\n'
|
||||
' comment\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
'is:\n'
|
||||
'another:\n'
|
||||
' - https://localhost/very/very/long/url\n'
|
||||
'...\n', conf)
|
||||
|
||||
conf = 'line-length: {max: 20, allow-non-breakable-words: no}'
|
||||
self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
' is:\n'
|
||||
' - a:\n'
|
||||
' http://localhost/very/long/url\n'
|
||||
'...\n', conf, problem=(5, 21))
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
' is:\n'
|
||||
' - a:\n'
|
||||
' # http://localhost/very/long/url\n'
|
||||
' comment\n'
|
||||
'...\n', conf, problem=(5, 21))
|
||||
self.check('---\n'
|
||||
'this:\n'
|
||||
'is:\n'
|
||||
'another:\n'
|
||||
' - https://localhost/very/very/long/url\n'
|
||||
'...\n', conf, problem=(5, 21))
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class NewLineAtEndOfFileTestCase(RuleTestCase):
|
||||
@@ -30,7 +30,7 @@ class NewLineAtEndOfFileTestCase(RuleTestCase):
|
||||
self.check('Sentence.\n', conf)
|
||||
|
||||
def test_enabled(self):
|
||||
conf = ('new-line-at-end-of-file: {}\n'
|
||||
conf = ('new-line-at-end-of-file: enable\n'
|
||||
'empty-lines: disable\n'
|
||||
'document-start: disable\n')
|
||||
self.check('', conf)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class NewLinesTestCase(RuleTestCase):
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
|
||||
|
||||
class YamlLintTestCase(RuleTestCase):
|
||||
rule_id = None # syntax error
|
||||
|
||||
def test_lint(self):
|
||||
self.check('---\n'
|
||||
'this is not: valid: YAML\n', None, problem=(2, 19))
|
||||
self.check('---\n'
|
||||
'this is: valid YAML\n'
|
||||
'\n'
|
||||
'this is an error: [\n'
|
||||
'\n'
|
||||
'...\n', None, problem=(6, 1))
|
||||
|
||||
def test_directives(self):
|
||||
self.check('%YAML 1.2\n'
|
||||
'%TAG ! tag:clarkevans.com,2002:\n'
|
||||
'doc: ument\n'
|
||||
'...\n', None, problem=(3, 1))
|
||||
@@ -14,7 +14,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.rules.common import RuleTestCase
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class TrailingSpacesTestCase(RuleTestCase):
|
||||
@@ -29,18 +29,18 @@ class TrailingSpacesTestCase(RuleTestCase):
|
||||
'some: text \n', conf)
|
||||
|
||||
def test_enabled(self):
|
||||
conf = 'trailing-spaces: {}'
|
||||
conf = 'trailing-spaces: enable'
|
||||
self.check('', conf)
|
||||
self.check('\n', conf)
|
||||
self.check(' \n', conf, problem=(1, 1))
|
||||
self.check('\t\t\t\n', conf, problem=(1, 1))
|
||||
self.check('\t\t\t\n', conf, problem=(1, 1, 'syntax'))
|
||||
self.check('---\n'
|
||||
'some: text \n', conf, problem=(2, 11))
|
||||
self.check('---\n'
|
||||
'some: text\t\n', conf, problem=(2, 11))
|
||||
'some: text\t\n', conf, problem=(2, 11, 'syntax'))
|
||||
|
||||
def test_with_dos_new_lines(self):
|
||||
conf = ('trailing-spaces: {}\n'
|
||||
conf = ('trailing-spaces: enable\n'
|
||||
'new-lines: {type: dos}\n')
|
||||
self.check('---\r\n'
|
||||
'some: text\r\n', conf)
|
||||
|
||||
329
tests/test_cli.py
Normal file
329
tests/test_cli.py
Normal file
@@ -0,0 +1,329 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
try:
|
||||
from cStringIO import StringIO
|
||||
except ImportError:
|
||||
from io import StringIO
|
||||
import locale
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
import unittest
|
||||
import sys
|
||||
|
||||
from yamllint import cli
|
||||
|
||||
|
||||
class CommandLineTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.wd = tempfile.mkdtemp(prefix='yamllint-tests-')
|
||||
|
||||
# .yaml file at root
|
||||
with open(os.path.join(self.wd, 'a.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'- 1 \n'
|
||||
'- 2')
|
||||
|
||||
# .yml file at root
|
||||
open(os.path.join(self.wd, 'empty.yml'), 'w').close()
|
||||
|
||||
# file in dir
|
||||
os.mkdir(os.path.join(self.wd, 'sub'))
|
||||
with open(os.path.join(self.wd, 'sub', 'ok.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n')
|
||||
|
||||
# file in very nested dir
|
||||
dir = self.wd
|
||||
for i in range(15):
|
||||
dir = os.path.join(dir, 's')
|
||||
os.mkdir(dir)
|
||||
with open(os.path.join(dir, 'file.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n'
|
||||
'key: other value\n')
|
||||
|
||||
# empty dir
|
||||
os.mkdir(os.path.join(self.wd, 'empty-dir'))
|
||||
|
||||
# non-YAML file
|
||||
with open(os.path.join(self.wd, 'no-yaml.json'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n')
|
||||
|
||||
# non-ASCII chars
|
||||
os.mkdir(os.path.join(self.wd, 'non-ascii'))
|
||||
with open(os.path.join(self.wd, 'non-ascii', 'utf-8'), 'wb') as f:
|
||||
f.write((u'---\n'
|
||||
u'- hétérogénéité\n'
|
||||
u'# 19.99 €\n'
|
||||
u'- お早う御座います。\n'
|
||||
u'# الأَبْجَدِيَّة العَرَبِيَّة\n').encode('utf-8'))
|
||||
|
||||
def tearDown(self):
|
||||
shutil.rmtree(self.wd)
|
||||
|
||||
def test_find_files_recursively(self):
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively([self.wd])),
|
||||
[os.path.join(self.wd, 'a.yaml'),
|
||||
os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'),
|
||||
os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'sub/ok.yaml'),
|
||||
os.path.join(self.wd, 'empty-dir')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'sub'),
|
||||
os.path.join(self.wd, '/etc/another/file')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, '/etc/another/file'),
|
||||
os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
def test_run_with_bad_arguments(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(())
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^usage')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('--unknown-arg', ))
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^usage')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-c', './conf.yaml', '-d', 'relaxed', 'file'))
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^Options --config-file and '
|
||||
r'--config-data cannot be used')
|
||||
|
||||
def test_run_with_bad_config(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-d', 'rules: {a: b}', 'file'))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^invalid config: no such rule')
|
||||
|
||||
def test_run_with_empty_config(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-d', '', 'file'))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^invalid config: not a dict')
|
||||
|
||||
def test_run_with_config_file(self):
|
||||
with open(os.path.join(self.wd, 'config'), 'w') as f:
|
||||
f.write('rules: {trailing-spaces: disable}')
|
||||
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
with open(os.path.join(self.wd, 'config'), 'w') as f:
|
||||
f.write('rules: {trailing-spaces: enable}')
|
||||
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
def test_run_with_user_global_config_file(self):
|
||||
home = os.path.join(self.wd, 'fake-home')
|
||||
os.mkdir(home)
|
||||
dir = os.path.join(home, '.config')
|
||||
os.mkdir(dir)
|
||||
dir = os.path.join(dir, 'yamllint')
|
||||
os.mkdir(dir)
|
||||
config = os.path.join(dir, 'config')
|
||||
|
||||
temp = os.environ['HOME']
|
||||
os.environ['HOME'] = home
|
||||
|
||||
with open(config, 'w') as f:
|
||||
f.write('rules: {trailing-spaces: disable}')
|
||||
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
with open(config, 'w') as f:
|
||||
f.write('rules: {trailing-spaces: enable}')
|
||||
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
os.environ['HOME'] = temp
|
||||
|
||||
def test_run_version(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('--version', ))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertRegexpMatches(out + err, r'yamllint \d+\.\d+')
|
||||
|
||||
def test_run_non_existing_file(self):
|
||||
file = os.path.join(self.wd, 'i-do-not-exist.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'No such file or directory')
|
||||
|
||||
def test_run_one_problem_file(self):
|
||||
file = os.path.join(self.wd, 'a.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'%s:2:4: [error] trailing spaces (trailing-spaces)\n'
|
||||
'%s:3:4: [error] no new line character at the end of file '
|
||||
'(new-line-at-end-of-file)\n') % (file, file))
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_one_ok_file(self):
|
||||
file = os.path.join(self.wd, 'sub', 'ok.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_empty_file(self):
|
||||
file = os.path.join(self.wd, 'empty.yml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_non_ascii_file(self):
|
||||
file = os.path.join(self.wd, 'non-ascii', 'utf-8')
|
||||
|
||||
# Make sure the default localization conditions on this "system"
|
||||
# support UTF-8 encoding.
|
||||
loc = locale.getlocale()
|
||||
locale.setlocale(locale.LC_ALL, 'C.UTF-8')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
locale.setlocale(locale.LC_ALL, loc)
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_multiple_files(self):
|
||||
items = [os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's')]
|
||||
file = items[1] + '/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(['-f', 'parsable'] + items)
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'%s:3:1: [error] duplication of key "key" in mapping '
|
||||
'(key-duplicates)\n') % file)
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_colored_output(self):
|
||||
file = os.path.join(self.wd, 'a.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run((file, ))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'\033[4m%s\033[0m\n'
|
||||
' \033[2m2:4\033[0m \033[31merror\033[0m '
|
||||
'trailing spaces \033[2m(trailing-spaces)\033[0m\n'
|
||||
' \033[2m3:4\033[0m \033[31merror\033[0m '
|
||||
'no new line character at the end of file '
|
||||
'\033[2m(new-line-at-end-of-file)\033[0m\n'
|
||||
'\n' % file))
|
||||
self.assertEqual(err, '')
|
||||
233
tests/test_config.py
Normal file
233
tests/test_config.py
Normal file
@@ -0,0 +1,233 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import unittest
|
||||
|
||||
from yamllint import config
|
||||
|
||||
|
||||
class SimpleConfigTestCase(unittest.TestCase):
|
||||
def test_parse_config(self):
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n')
|
||||
|
||||
self.assertEqual(list(new.rules.keys()), ['colons'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 1)
|
||||
|
||||
def test_invalid_conf(self):
|
||||
with self.assertRaises(config.YamlLintConfigError):
|
||||
config.YamlLintConfig('not: valid: yaml')
|
||||
|
||||
def test_unknown_rule(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: no such rule: "this-one-does-not-exist"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' this-one-does-not-exist: enable\n')
|
||||
|
||||
def test_missing_option(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: missing option "max-spaces-before" '
|
||||
'for rule "colons"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-after: 1\n')
|
||||
|
||||
def test_unknown_option(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: unknown option "abcdef" for rule "colons"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' abcdef: yes\n')
|
||||
|
||||
def test_validate_rule_conf(self):
|
||||
class Rule(object):
|
||||
ID = 'fake'
|
||||
|
||||
self.assertEqual(config.validate_rule_conf(Rule, False), False)
|
||||
self.assertEqual(config.validate_rule_conf(Rule, 'disable'), False)
|
||||
|
||||
self.assertEqual(config.validate_rule_conf(Rule, {}),
|
||||
{'level': 'error'})
|
||||
self.assertEqual(config.validate_rule_conf(Rule, 'enable'),
|
||||
{'level': 'error'})
|
||||
|
||||
config.validate_rule_conf(Rule, {'level': 'error'})
|
||||
config.validate_rule_conf(Rule, {'level': 'warning'})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'level': 'warn'})
|
||||
|
||||
Rule.CONF = {'length': int}
|
||||
config.validate_rule_conf(Rule, {'length': 8})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'height': 8})
|
||||
|
||||
Rule.CONF = {'a': bool, 'b': int}
|
||||
config.validate_rule_conf(Rule, {'a': True, 'b': 0})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'a': True})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'b': 0})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'a': 1, 'b': 0})
|
||||
|
||||
Rule.CONF = {'choice': (True, 88, 'str')}
|
||||
config.validate_rule_conf(Rule, {'choice': True})
|
||||
config.validate_rule_conf(Rule, {'choice': 88})
|
||||
config.validate_rule_conf(Rule, {'choice': 'str'})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'choice': False})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'choice': 99})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'choice': 'abc'})
|
||||
|
||||
Rule.CONF = {'choice': (int, 'hardcoded')}
|
||||
config.validate_rule_conf(Rule, {'choice': 42})
|
||||
config.validate_rule_conf(Rule, {'choice': 'hardcoded'})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'choice': False})
|
||||
self.assertRaises(config.YamlLintConfigError,
|
||||
config.validate_rule_conf, Rule, {'choice': 'abc'})
|
||||
|
||||
|
||||
class ExtendedConfigTestCase(unittest.TestCase):
|
||||
def test_extend_add_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
def test_extend_remove_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons: disable\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons'], False)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 1)
|
||||
|
||||
def test_extend_edit_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 3\n'
|
||||
' max-spaces-after: 4\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 3)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 4)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
def test_extend_reenable_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens: disable\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
|
||||
class ExtendedLibraryConfigTestCase(unittest.TestCase):
|
||||
def test_extend_config_disable_rule(self):
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' trailing-spaces: disable\n')
|
||||
|
||||
old.rules['trailing-spaces'] = False
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
|
||||
def test_extend_config_override_whole_rule(self):
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max: 42\n'
|
||||
' max-start: 43\n'
|
||||
' max-end: 44\n')
|
||||
|
||||
old.rules['empty-lines']['max'] = 42
|
||||
old.rules['empty-lines']['max-start'] = 43
|
||||
old.rules['empty-lines']['max-end'] = 44
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
|
||||
def test_extend_config_override_rule_partly(self):
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max-start: 42\n')
|
||||
|
||||
old.rules['empty-lines']['max-start'] = 42
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
58
tests/test_linter.py
Normal file
58
tests/test_linter.py
Normal file
@@ -0,0 +1,58 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import io
|
||||
|
||||
import unittest
|
||||
|
||||
from yamllint.config import YamlLintConfig
|
||||
from yamllint import linter
|
||||
|
||||
|
||||
class LinterTestCase(unittest.TestCase):
|
||||
def fake_config(self):
|
||||
return YamlLintConfig('extends: default')
|
||||
|
||||
def test_run_on_string(self):
|
||||
linter.run('test: document', self.fake_config())
|
||||
|
||||
def test_run_on_bytes(self):
|
||||
linter.run(b'test: document', self.fake_config())
|
||||
|
||||
def test_run_on_unicode(self):
|
||||
linter.run(u'test: document', self.fake_config())
|
||||
|
||||
def test_run_on_stream(self):
|
||||
linter.run(io.StringIO(u'hello'), self.fake_config())
|
||||
|
||||
def test_run_on_int(self):
|
||||
self.assertRaises(TypeError, linter.run, 42, self.fake_config())
|
||||
|
||||
def test_run_on_list(self):
|
||||
self.assertRaises(TypeError, linter.run,
|
||||
['h', 'e', 'l', 'l', 'o'], self.fake_config())
|
||||
|
||||
def test_run_on_non_ascii_chars(self):
|
||||
s = (u'- hétérogénéité\n'
|
||||
u'# 19.99 €\n')
|
||||
linter.run(s, self.fake_config())
|
||||
linter.run(s.encode('utf-8'), self.fake_config())
|
||||
linter.run(s.encode('iso-8859-15'), self.fake_config())
|
||||
|
||||
s = (u'- お早う御座います。\n'
|
||||
u'# الأَبْجَدِيَّة العَرَبِيَّة\n')
|
||||
linter.run(s, self.fake_config())
|
||||
linter.run(s.encode('utf-8'), self.fake_config())
|
||||
@@ -18,8 +18,9 @@ import unittest
|
||||
|
||||
import yaml
|
||||
|
||||
from yamllint.parser import (line_generator, token_generator,
|
||||
token_or_line_generator, Line, Token)
|
||||
from yamllint.parser import (line_generator, token_or_comment_generator,
|
||||
token_or_comment_or_line_generator,
|
||||
Line, Token, Comment)
|
||||
|
||||
|
||||
class ParserTestCase(unittest.TestCase):
|
||||
@@ -61,33 +62,92 @@ class ParserTestCase(unittest.TestCase):
|
||||
self.assertEqual(e[2].line_no, 3)
|
||||
self.assertEqual(e[2].content, 'at the end')
|
||||
|
||||
def test_token_generator(self):
|
||||
e = list(token_generator(''))
|
||||
def test_token_or_comment_generator(self):
|
||||
e = list(token_or_comment_generator(''))
|
||||
self.assertEqual(len(e), 2)
|
||||
self.assertEqual(e[0].prev, None)
|
||||
self.assertTrue(isinstance(e[0].curr, yaml.Token))
|
||||
self.assertTrue(isinstance(e[0].next, yaml.Token))
|
||||
self.assertIsInstance(e[0].curr, yaml.Token)
|
||||
self.assertIsInstance(e[0].next, yaml.Token)
|
||||
self.assertEqual(e[1].prev, e[0].curr)
|
||||
self.assertEqual(e[1].curr, e[0].next)
|
||||
self.assertEqual(e[1].next, None)
|
||||
|
||||
e = list(token_generator('---\n'
|
||||
e = list(token_or_comment_generator('---\n'
|
||||
'k: v\n'))
|
||||
self.assertEqual(len(e), 9)
|
||||
self.assertTrue(isinstance(e[3].curr, yaml.KeyToken))
|
||||
self.assertTrue(isinstance(e[5].curr, yaml.ValueToken))
|
||||
self.assertIsInstance(e[3].curr, yaml.KeyToken)
|
||||
self.assertIsInstance(e[5].curr, yaml.ValueToken)
|
||||
|
||||
def test_token_or_line_generator(self):
|
||||
e = list(token_or_line_generator('---\n'
|
||||
'k: v\n'))
|
||||
self.assertEqual(len(e), 12)
|
||||
self.assertTrue(isinstance(e[0], Token))
|
||||
self.assertTrue(isinstance(e[0].curr, yaml.StreamStartToken))
|
||||
self.assertTrue(isinstance(e[1], Token))
|
||||
self.assertTrue(isinstance(e[1].curr, yaml.DocumentStartToken))
|
||||
self.assertTrue(isinstance(e[2], Line))
|
||||
self.assertTrue(isinstance(e[3].curr, yaml.BlockMappingStartToken))
|
||||
self.assertTrue(isinstance(e[4].curr, yaml.KeyToken))
|
||||
self.assertTrue(isinstance(e[6].curr, yaml.ValueToken))
|
||||
self.assertTrue(isinstance(e[8], Line))
|
||||
self.assertTrue(isinstance(e[11], Line))
|
||||
e = list(token_or_comment_generator('# start comment\n'
|
||||
'- a\n'
|
||||
'- key: val # key=val\n'
|
||||
'# this is\n'
|
||||
'# a block \n'
|
||||
'# comment\n'
|
||||
'- c\n'
|
||||
'# end comment\n'))
|
||||
self.assertEqual(len(e), 21)
|
||||
self.assertIsInstance(e[1], Comment)
|
||||
self.assertEqual(e[1], Comment(1, 1, '# start comment', 0))
|
||||
self.assertEqual(e[11], Comment(3, 13, '# key=val', 0))
|
||||
self.assertEqual(e[12], Comment(4, 1, '# this is', 0))
|
||||
self.assertEqual(e[13], Comment(5, 1, '# a block ', 0))
|
||||
self.assertEqual(e[14], Comment(6, 1, '# comment', 0))
|
||||
self.assertEqual(e[18], Comment(8, 1, '# end comment', 0))
|
||||
|
||||
e = list(token_or_comment_generator('---\n'
|
||||
'# no newline char'))
|
||||
self.assertEqual(e[2], Comment(2, 1, '# no newline char', 0))
|
||||
|
||||
e = list(token_or_comment_generator('# just comment'))
|
||||
self.assertEqual(e[1], Comment(1, 1, '# just comment', 0))
|
||||
|
||||
e = list(token_or_comment_generator('\n'
|
||||
' # indented comment\n'))
|
||||
self.assertEqual(e[1], Comment(2, 4, '# indented comment', 0))
|
||||
|
||||
e = list(token_or_comment_generator('\n'
|
||||
'# trailing spaces \n'))
|
||||
self.assertEqual(e[1], Comment(2, 1, '# trailing spaces ', 0))
|
||||
|
||||
e = [c for c in
|
||||
token_or_comment_generator('# block\n'
|
||||
'# comment\n'
|
||||
'- data # inline comment\n'
|
||||
'# block\n'
|
||||
'# comment\n'
|
||||
'- k: v # inline comment\n'
|
||||
'- [ l, ist\n'
|
||||
'] # inline comment\n'
|
||||
'- { m: ap\n'
|
||||
'} # inline comment\n'
|
||||
'# block comment\n'
|
||||
'- data # inline comment\n')
|
||||
if isinstance(c, Comment)]
|
||||
self.assertEqual(len(e), 10)
|
||||
self.assertFalse(e[0].is_inline())
|
||||
self.assertFalse(e[1].is_inline())
|
||||
self.assertTrue(e[2].is_inline())
|
||||
self.assertFalse(e[3].is_inline())
|
||||
self.assertFalse(e[4].is_inline())
|
||||
self.assertTrue(e[5].is_inline())
|
||||
self.assertTrue(e[6].is_inline())
|
||||
self.assertTrue(e[7].is_inline())
|
||||
self.assertFalse(e[8].is_inline())
|
||||
self.assertTrue(e[9].is_inline())
|
||||
|
||||
def test_token_or_comment_or_line_generator(self):
|
||||
e = list(token_or_comment_or_line_generator('---\n'
|
||||
'k: v # k=v\n'))
|
||||
self.assertEqual(len(e), 13)
|
||||
self.assertIsInstance(e[0], Token)
|
||||
self.assertIsInstance(e[0].curr, yaml.StreamStartToken)
|
||||
self.assertIsInstance(e[1], Token)
|
||||
self.assertIsInstance(e[1].curr, yaml.DocumentStartToken)
|
||||
self.assertIsInstance(e[2], Line)
|
||||
self.assertIsInstance(e[3].curr, yaml.BlockMappingStartToken)
|
||||
self.assertIsInstance(e[4].curr, yaml.KeyToken)
|
||||
self.assertIsInstance(e[6].curr, yaml.ValueToken)
|
||||
self.assertIsInstance(e[8], Comment)
|
||||
self.assertIsInstance(e[9], Line)
|
||||
self.assertIsInstance(e[12], Line)
|
||||
|
||||
186
tests/test_spec_examples.py
Normal file
186
tests/test_spec_examples.py
Normal file
@@ -0,0 +1,186 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from io import open
|
||||
import os
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
# This file checks examples from YAML 1.2 specification [1] against yamllint.
|
||||
#
|
||||
# [1]: http://www.yaml.org/spec/1.2/spec.html
|
||||
#
|
||||
# Example files generated with:
|
||||
#
|
||||
# from bs4 import BeautifulSoup
|
||||
# with open('spec.html', encoding='iso-8859-1') as f:
|
||||
# soup = BeautifulSoup(f, 'lxml')
|
||||
# for ex in soup.find_all('div', class_='example'):
|
||||
# title = ex.find('p', class_='title').find('b').get_text()
|
||||
# id = '-'.join(title.split('\xa0')[:2])[:-1].lower()
|
||||
# span = ex.find('span', class_='database')
|
||||
# for br in span.find_all("br"):
|
||||
# br.replace_with("\n")
|
||||
# text = text.replace('\u2193', '') # downwards arrow
|
||||
# text = text.replace('\u21d3', '') # double downwards arrow
|
||||
# text = text.replace('\u00b7', ' ') # visible space
|
||||
# text = text.replace('\u21d4', '') # byte order mark
|
||||
# text = text.replace('\u2192', '\t') # right arrow
|
||||
# text = text.replace('\u00b0', '') # empty scalar
|
||||
# with open('tests/yaml-1.2-spec-examples/%s' % id, 'w',
|
||||
# encoding='utf-8') as g:
|
||||
# g.write(text)
|
||||
|
||||
class SpecificationTestCase(RuleTestCase):
|
||||
rule_id = None
|
||||
|
||||
conf_general = ('document-start: disable\n'
|
||||
'comments: {min-spaces-from-content: 1}\n'
|
||||
'braces: {min-spaces-inside: 1, max-spaces-inside: 1}\n'
|
||||
'brackets: {min-spaces-inside: 1, max-spaces-inside: 1}\n')
|
||||
conf_overrides = {
|
||||
'example-2.2': ('colons: {max-spaces-after: 2}\n'),
|
||||
'example-2.4': ('colons: {max-spaces-after: 3}\n'),
|
||||
'example-2.5': ('empty-lines: {max-end: 2}\n'
|
||||
'brackets: {min-spaces-inside: 0, max-spaces-inside: 2}\n'
|
||||
'commas: {max-spaces-before: -1}\n'),
|
||||
'example-2.6': ('braces: {min-spaces-inside: 0, max-spaces-inside: 0}\n'
|
||||
'indentation: disable\n'),
|
||||
'example-2.12': ('empty-lines: {max-end: 1}\n'
|
||||
'colons: {max-spaces-before: -1}\n'),
|
||||
'example-2.16': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-2.18': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-2.19': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-2.28': ('empty-lines: {max-end: 3}\n'),
|
||||
'example-5.3': ('indentation: {indent-sequences: no}\n'
|
||||
'colons: {max-spaces-before: 1}\n'),
|
||||
'example-6.4': ('trailing-spaces: disable\n'),
|
||||
'example-6.5': ('trailing-spaces: disable\n'),
|
||||
'example-6.6': ('trailing-spaces: disable\n'),
|
||||
'example-6.7': ('trailing-spaces: disable\n'),
|
||||
'example-6.8': ('trailing-spaces: disable\n'),
|
||||
'example-6.10': ('empty-lines: {max-end: 2}\n'
|
||||
'trailing-spaces: disable\n'
|
||||
'comments-indentation: disable\n'),
|
||||
'example-6.11': ('empty-lines: {max-end: 1}\n'
|
||||
'comments-indentation: disable\n'),
|
||||
'example-6.13': ('comments-indentation: disable\n'),
|
||||
'example-6.14': ('comments-indentation: disable\n'),
|
||||
'example-6.23': ('colons: {max-spaces-before: 1}\n'),
|
||||
'example-7.4': ('colons: {max-spaces-before: 1}\n'
|
||||
'indentation: disable\n'),
|
||||
'example-7.5': ('trailing-spaces: disable\n'),
|
||||
'example-7.6': ('trailing-spaces: disable\n'),
|
||||
'example-7.7': ('indentation: disable\n'),
|
||||
'example-7.8': ('colons: {max-spaces-before: 1}\n'
|
||||
'indentation: disable\n'),
|
||||
'example-7.9': ('trailing-spaces: disable\n'),
|
||||
'example-7.11': ('colons: {max-spaces-before: 1}\n'
|
||||
'indentation: disable\n'),
|
||||
'example-7.13': ('brackets: {min-spaces-inside: 0, max-spaces-inside: 1}\n'
|
||||
'commas: {max-spaces-before: 1, min-spaces-after: 0}\n'),
|
||||
'example-7.14': ('indentation: disable\n'),
|
||||
'example-7.15': ('braces: {min-spaces-inside: 0, max-spaces-inside: 1}\n'
|
||||
'commas: {max-spaces-before: 1, min-spaces-after: 0}\n'
|
||||
'colons: {max-spaces-before: 1}\n'),
|
||||
'example-7.16': ('indentation: disable\n'),
|
||||
'example-7.17': ('indentation: disable\n'),
|
||||
'example-7.18': ('indentation: disable\n'),
|
||||
'example-7.19': ('indentation: disable\n'),
|
||||
'example-7.20': ('colons: {max-spaces-before: 1}\n'
|
||||
'indentation: disable\n'),
|
||||
'example-8.1': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-8.2': ('trailing-spaces: disable\n'),
|
||||
'example-8.5': ('comments-indentation: disable\n'
|
||||
'trailing-spaces: disable\n'),
|
||||
'example-8.6': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-8.7': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-8.8': ('trailing-spaces: disable\n'),
|
||||
'example-8.9': ('empty-lines: {max-end: 1}\n'),
|
||||
'example-8.14': ('colons: {max-spaces-before: 1}\n'),
|
||||
'example-8.16': ('indentation: {spaces: 1}\n'),
|
||||
'example-8.17': ('indentation: disable\n'),
|
||||
'example-8.20': ('indentation: {indent-sequences: no}\n'
|
||||
'colons: {max-spaces-before: 1}\n'),
|
||||
'example-8.22': ('indentation: disable\n'),
|
||||
'example-10.1': ('colons: {max-spaces-before: 2}\n'),
|
||||
'example-10.2': ('indentation: {indent-sequences: no}\n'),
|
||||
}
|
||||
|
||||
files = os.listdir(os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
||||
'yaml-1.2-spec-examples'))
|
||||
assert len(files) == 132
|
||||
|
||||
|
||||
def _gen_test(buffer, conf):
|
||||
def test(self):
|
||||
self.check(buffer, conf)
|
||||
return test
|
||||
|
||||
# The following tests are blacklisted (i.e. will not be checked against
|
||||
# yamllint), because pyyaml is currently not able to parse the contents
|
||||
# (using yaml.parse()).
|
||||
pyyaml_blacklist = (
|
||||
'example-2.11',
|
||||
'example-2.23',
|
||||
'example-2.24',
|
||||
'example-2.27',
|
||||
'example-5.10',
|
||||
'example-5.12',
|
||||
'example-5.13',
|
||||
'example-5.14',
|
||||
'example-5.6',
|
||||
'example-6.1',
|
||||
'example-6.12',
|
||||
'example-6.15',
|
||||
'example-6.17',
|
||||
'example-6.18',
|
||||
'example-6.19',
|
||||
'example-6.2',
|
||||
'example-6.20',
|
||||
'example-6.21',
|
||||
'example-6.22',
|
||||
'example-6.24',
|
||||
'example-6.25',
|
||||
'example-6.26',
|
||||
'example-6.27',
|
||||
'example-6.3',
|
||||
'example-7.1',
|
||||
'example-7.10',
|
||||
'example-7.12',
|
||||
'example-7.17',
|
||||
'example-7.2',
|
||||
'example-7.21',
|
||||
'example-7.22',
|
||||
'example-7.3',
|
||||
'example-8.18',
|
||||
'example-8.19',
|
||||
'example-8.21',
|
||||
'example-8.3',
|
||||
'example-9.3',
|
||||
'example-9.4',
|
||||
'example-9.5',
|
||||
)
|
||||
|
||||
for file in files:
|
||||
if file in pyyaml_blacklist:
|
||||
continue
|
||||
|
||||
with open('tests/yaml-1.2-spec-examples/' + file, encoding='utf-8') as f:
|
||||
conf = conf_general + conf_overrides.get(file, '')
|
||||
setattr(SpecificationTestCase, 'test_' + file,
|
||||
_gen_test(f.read(), conf))
|
||||
94
tests/test_syntax_errors.py
Normal file
94
tests/test_syntax_errors.py
Normal file
@@ -0,0 +1,94 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class YamlLintTestCase(RuleTestCase):
|
||||
rule_id = None # syntax error
|
||||
|
||||
def test_syntax_errors(self):
|
||||
self.check('---\n'
|
||||
'this is not: valid: YAML\n', None, problem=(2, 19))
|
||||
self.check('---\n'
|
||||
'this is: valid YAML\n'
|
||||
'\n'
|
||||
'this is an error: [\n'
|
||||
'\n'
|
||||
'...\n', None, problem=(6, 1))
|
||||
self.check('%YAML 1.2\n'
|
||||
'%TAG ! tag:clarkevans.com,2002:\n'
|
||||
'doc: ument\n'
|
||||
'...\n', None, problem=(3, 1))
|
||||
|
||||
def test_empty_flows(self):
|
||||
self.check('---\n'
|
||||
'- []\n'
|
||||
'- {}\n'
|
||||
'- [\n'
|
||||
']\n'
|
||||
'- {\n'
|
||||
'}\n'
|
||||
'...\n', None)
|
||||
|
||||
def test_explicit_mapping(self):
|
||||
self.check('---\n'
|
||||
'? key\n'
|
||||
': - value 1\n'
|
||||
' - value 2\n'
|
||||
'...\n', None)
|
||||
self.check('---\n'
|
||||
'?\n'
|
||||
' key\n'
|
||||
': {a: 1}\n'
|
||||
'...\n', None)
|
||||
self.check('---\n'
|
||||
'?\n'
|
||||
' key\n'
|
||||
':\n'
|
||||
' val\n'
|
||||
'...\n', None)
|
||||
|
||||
def test_mapping_between_sequences(self):
|
||||
# This is valid YAML. See http://www.yaml.org/spec/1.2/spec.html,
|
||||
# example 2.11
|
||||
self.check('---\n'
|
||||
'? - Detroit Tigers\n'
|
||||
' - Chicago cubs\n'
|
||||
':\n'
|
||||
' - 2001-07-23\n'
|
||||
'\n'
|
||||
'? [New York Yankees,\n'
|
||||
' Atlanta Braves]\n'
|
||||
': [2001-07-02, 2001-08-12,\n'
|
||||
' 2001-08-14]\n', None)
|
||||
|
||||
def test_sets(self):
|
||||
self.check('---\n'
|
||||
'? key one\n'
|
||||
'? key two\n'
|
||||
'? [non, scalar, key]\n'
|
||||
'? key with value\n'
|
||||
': value\n'
|
||||
'...\n', None)
|
||||
self.check('---\n'
|
||||
'? - multi\n'
|
||||
' - line\n'
|
||||
' - keys\n'
|
||||
'? in:\n'
|
||||
' a:\n'
|
||||
' set\n'
|
||||
'...\n', None)
|
||||
304
tests/test_yamllint_directives.py
Normal file
304
tests/test_yamllint_directives.py
Normal file
@@ -0,0 +1,304 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class YamllintDirectivesTestCase(RuleTestCase):
|
||||
conf = ('commas: disable\n'
|
||||
'trailing-spaces: {}\n'
|
||||
'colons: {max-spaces-before: 1}\n')
|
||||
|
||||
def test_disable_directive(self):
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(4, 8, 'colons'),
|
||||
problem3=(6, 7, 'colons'),
|
||||
problem4=(6, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'# yamllint disable\n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem=(3, 18, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint enable\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(8, 7, 'colons'),
|
||||
problem2=(8, 26, 'trailing-spaces'))
|
||||
|
||||
def test_disable_directive_with_rules(self):
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'# yamllint disable rule:trailing-spaces\n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(5, 8, 'colons'),
|
||||
problem3=(7, 7, 'colons'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable rule:trailing-spaces\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint enable rule:trailing-spaces\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(5, 8, 'colons'),
|
||||
problem2=(8, 7, 'colons'),
|
||||
problem3=(8, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable rule:trailing-spaces\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint enable\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(5, 8, 'colons'),
|
||||
problem2=(8, 7, 'colons'),
|
||||
problem3=(8, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint enable rule:trailing-spaces\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem=(8, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable rule:colons\n'
|
||||
'- trailing spaces \n'
|
||||
'# yamllint disable rule:trailing-spaces\n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint enable rule:colons\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(4, 18, 'trailing-spaces'),
|
||||
problem2=(9, 7, 'colons'))
|
||||
|
||||
def test_disable_line_directive(self):
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'# yamllint disable-line\n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(7, 7, 'colons'),
|
||||
problem3=(7, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon # yamllint disable-line\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(6, 7, 'colons'),
|
||||
problem3=(6, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML] # yamllint disable-line\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(4, 8, 'colons'),
|
||||
problem3=(6, 7, 'colons'),
|
||||
problem4=(6, 26, 'trailing-spaces'))
|
||||
|
||||
def test_disable_line_directive_with_rules(self):
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable-line rule:colons\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(4, 18, 'trailing-spaces'),
|
||||
problem2=(5, 8, 'colons'),
|
||||
problem3=(7, 7, 'colons'),
|
||||
problem4=(7, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces # yamllint disable-line rule:colons \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 55, 'trailing-spaces'),
|
||||
problem2=(4, 8, 'colons'),
|
||||
problem3=(6, 7, 'colons'),
|
||||
problem4=(6, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'# yamllint disable-line rule:colons\n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(7, 7, 'colons'),
|
||||
problem3=(7, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon # yamllint disable-line rule:colons\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(6, 7, 'colons'),
|
||||
problem3=(6, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable-line rule:colons\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(4, 8, 'colons'),
|
||||
problem3=(7, 26, 'trailing-spaces'))
|
||||
self.check('---\n'
|
||||
'- [valid , YAML]\n'
|
||||
'- trailing spaces \n'
|
||||
'- bad : colon\n'
|
||||
'- [valid , YAML]\n'
|
||||
'# yamllint disable-line rule:colons rule:trailing-spaces\n'
|
||||
'- bad : colon and spaces \n'
|
||||
'- [valid , YAML]\n',
|
||||
self.conf,
|
||||
problem1=(3, 18, 'trailing-spaces'),
|
||||
problem2=(4, 8, 'colons'))
|
||||
|
||||
def test_directive_on_last_line(self):
|
||||
conf = 'new-line-at-end-of-file: {}'
|
||||
self.check('---\n'
|
||||
'no new line',
|
||||
conf,
|
||||
problem=(2, 12, 'new-line-at-end-of-file'))
|
||||
self.check('---\n'
|
||||
'# yamllint disable\n'
|
||||
'no new line',
|
||||
conf)
|
||||
self.check('---\n'
|
||||
'no new line # yamllint disable',
|
||||
conf)
|
||||
|
||||
def test_indented_directive(self):
|
||||
conf = 'brackets: {min-spaces-inside: 0, max-spaces-inside: 0}'
|
||||
self.check('---\n'
|
||||
'- a: 1\n'
|
||||
' b:\n'
|
||||
' c: [ x]\n',
|
||||
conf,
|
||||
problem=(4, 12, 'brackets'))
|
||||
self.check('---\n'
|
||||
'- a: 1\n'
|
||||
' b:\n'
|
||||
' # yamllint disable-line rule:brackets\n'
|
||||
' c: [ x]\n',
|
||||
conf)
|
||||
|
||||
def test_directive_on_itself(self):
|
||||
conf = ('comments: {min-spaces-from-content: 2}\n'
|
||||
'comments-indentation: {}\n')
|
||||
self.check('---\n'
|
||||
'- a: 1 # comment too close\n'
|
||||
' b:\n'
|
||||
' # wrong indentation\n'
|
||||
' c: [x]\n',
|
||||
conf,
|
||||
problem1=(2, 8, 'comments'),
|
||||
problem2=(4, 2, 'comments-indentation'))
|
||||
self.check('---\n'
|
||||
'# yamllint disable\n'
|
||||
'- a: 1 # comment too close\n'
|
||||
' b:\n'
|
||||
' # wrong indentation\n'
|
||||
' c: [x]\n',
|
||||
conf)
|
||||
self.check('---\n'
|
||||
'- a: 1 # yamllint disable-line\n'
|
||||
' b:\n'
|
||||
' # yamllint disable-line\n'
|
||||
' # wrong indentation\n'
|
||||
' c: [x]\n',
|
||||
conf)
|
||||
self.check('---\n'
|
||||
'- a: 1 # yamllint disable-line rule:comments\n'
|
||||
' b:\n'
|
||||
' # yamllint disable-line rule:comments-indentation\n'
|
||||
' # wrong indentation\n'
|
||||
' c: [x]\n',
|
||||
conf)
|
||||
self.check('---\n'
|
||||
'# yamllint disable\n'
|
||||
'- a: 1 # comment too close\n'
|
||||
' # yamllint enable rule:comments-indentation\n'
|
||||
' b:\n'
|
||||
' # wrong indentation\n'
|
||||
' c: [x]\n',
|
||||
conf,
|
||||
problem=(6, 2, 'comments-indentation'))
|
||||
6
tests/yaml-1.2-spec-examples/example-10.1
Normal file
6
tests/yaml-1.2-spec-examples/example-10.1
Normal file
@@ -0,0 +1,6 @@
|
||||
Block style: !!map
|
||||
Clark : Evans
|
||||
Ingy : döt Net
|
||||
Oren : Ben-Kiki
|
||||
|
||||
Flow style: !!map { Clark: Evans, Ingy: döt Net, Oren: Ben-Kiki }
|
||||
6
tests/yaml-1.2-spec-examples/example-10.2
Normal file
6
tests/yaml-1.2-spec-examples/example-10.2
Normal file
@@ -0,0 +1,6 @@
|
||||
Block style: !!seq
|
||||
- Clark Evans
|
||||
- Ingy döt Net
|
||||
- Oren Ben-Kiki
|
||||
|
||||
Flow style: !!seq [ Clark Evans, Ingy döt Net, Oren Ben-Kiki ]
|
||||
4
tests/yaml-1.2-spec-examples/example-10.3
Normal file
4
tests/yaml-1.2-spec-examples/example-10.3
Normal file
@@ -0,0 +1,4 @@
|
||||
Block style: !!str |-
|
||||
String: just a theory.
|
||||
|
||||
Flow style: !!str "String: just a theory."
|
||||
2
tests/yaml-1.2-spec-examples/example-10.4
Normal file
2
tests/yaml-1.2-spec-examples/example-10.4
Normal file
@@ -0,0 +1,2 @@
|
||||
!!null null: value for null key
|
||||
key with null value: !!null null
|
||||
2
tests/yaml-1.2-spec-examples/example-10.5
Normal file
2
tests/yaml-1.2-spec-examples/example-10.5
Normal file
@@ -0,0 +1,2 @@
|
||||
YAML is a superset of JSON: !!bool true
|
||||
Pluto is a planet: !!bool false
|
||||
3
tests/yaml-1.2-spec-examples/example-10.6
Normal file
3
tests/yaml-1.2-spec-examples/example-10.6
Normal file
@@ -0,0 +1,3 @@
|
||||
negative: !!int -12
|
||||
zero: !!int 0
|
||||
positive: !!int 34
|
||||
5
tests/yaml-1.2-spec-examples/example-10.7
Normal file
5
tests/yaml-1.2-spec-examples/example-10.7
Normal file
@@ -0,0 +1,5 @@
|
||||
negative: !!float -1
|
||||
zero: !!float 0
|
||||
positive: !!float 2.3e4
|
||||
infinity: !!float .inf
|
||||
not a number: !!float .nan
|
||||
5
tests/yaml-1.2-spec-examples/example-10.8
Normal file
5
tests/yaml-1.2-spec-examples/example-10.8
Normal file
@@ -0,0 +1,5 @@
|
||||
A null: null
|
||||
Booleans: [ true, false ]
|
||||
Integers: [ 0, -0, 3, -19 ]
|
||||
Floats: [ 0., -0.0, 12e03, -2E+05 ]
|
||||
Invalid: [ True, Null, 0o7, 0x3A, +12.3 ]
|
||||
7
tests/yaml-1.2-spec-examples/example-10.9
Normal file
7
tests/yaml-1.2-spec-examples/example-10.9
Normal file
@@ -0,0 +1,7 @@
|
||||
A null: null
|
||||
Also a null: # Empty
|
||||
Not a null: ""
|
||||
Booleans: [ true, True, false, FALSE ]
|
||||
Integers: [ 0, 0o7, 0x3A, -19 ]
|
||||
Floats: [ 0., -0.0, .5, +12e03, -2E+05 ]
|
||||
Also floats: [ .inf, -.Inf, +.INF, .NAN ]
|
||||
3
tests/yaml-1.2-spec-examples/example-2.1
Normal file
3
tests/yaml-1.2-spec-examples/example-2.1
Normal file
@@ -0,0 +1,3 @@
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
8
tests/yaml-1.2-spec-examples/example-2.10
Normal file
8
tests/yaml-1.2-spec-examples/example-2.10
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
hr:
|
||||
- Mark McGwire
|
||||
# Following node labeled SS
|
||||
- &SS Sammy Sosa
|
||||
rbi:
|
||||
- *SS # Subsequent occurrence
|
||||
- Ken Griffey
|
||||
9
tests/yaml-1.2-spec-examples/example-2.11
Normal file
9
tests/yaml-1.2-spec-examples/example-2.11
Normal file
@@ -0,0 +1,9 @@
|
||||
? - Detroit Tigers
|
||||
- Chicago cubs
|
||||
:
|
||||
- 2001-07-23
|
||||
|
||||
? [ New York Yankees,
|
||||
Atlanta Braves ]
|
||||
: [ 2001-07-02, 2001-08-12,
|
||||
2001-08-14 ]
|
||||
9
tests/yaml-1.2-spec-examples/example-2.12
Normal file
9
tests/yaml-1.2-spec-examples/example-2.12
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
# Products purchased
|
||||
- item : Super Hoop
|
||||
quantity: 1
|
||||
- item : Basketball
|
||||
quantity: 4
|
||||
- item : Big Shoes
|
||||
quantity: 1
|
||||
|
||||
4
tests/yaml-1.2-spec-examples/example-2.13
Normal file
4
tests/yaml-1.2-spec-examples/example-2.13
Normal file
@@ -0,0 +1,4 @@
|
||||
# ASCII Art
|
||||
--- |
|
||||
\//||\/||
|
||||
// || ||__
|
||||
4
tests/yaml-1.2-spec-examples/example-2.14
Normal file
4
tests/yaml-1.2-spec-examples/example-2.14
Normal file
@@ -0,0 +1,4 @@
|
||||
--- >
|
||||
Mark McGwire's
|
||||
year was crippled
|
||||
by a knee injury.
|
||||
8
tests/yaml-1.2-spec-examples/example-2.15
Normal file
8
tests/yaml-1.2-spec-examples/example-2.15
Normal file
@@ -0,0 +1,8 @@
|
||||
>
|
||||
Sammy Sosa completed another
|
||||
fine season with great stats.
|
||||
|
||||
63 Home Runs
|
||||
0.288 Batting Average
|
||||
|
||||
What a year!
|
||||
8
tests/yaml-1.2-spec-examples/example-2.16
Normal file
8
tests/yaml-1.2-spec-examples/example-2.16
Normal file
@@ -0,0 +1,8 @@
|
||||
name: Mark McGwire
|
||||
accomplishment: >
|
||||
Mark set a major league
|
||||
home run record in 1998.
|
||||
stats: |
|
||||
65 Home Runs
|
||||
0.278 Batting Average
|
||||
|
||||
7
tests/yaml-1.2-spec-examples/example-2.17
Normal file
7
tests/yaml-1.2-spec-examples/example-2.17
Normal file
@@ -0,0 +1,7 @@
|
||||
unicode: "Sosa did fine.\u263A"
|
||||
control: "\b1998\t1999\t2000\n"
|
||||
hex esc: "\x0d\x0a is \r\n"
|
||||
|
||||
single: '"Howdy!" he cried.'
|
||||
quoted: ' # Not a ''comment''.'
|
||||
tie-fighter: '|\-*-/|'
|
||||
7
tests/yaml-1.2-spec-examples/example-2.18
Normal file
7
tests/yaml-1.2-spec-examples/example-2.18
Normal file
@@ -0,0 +1,7 @@
|
||||
plain:
|
||||
This unquoted scalar
|
||||
spans many lines.
|
||||
|
||||
quoted: "So does this
|
||||
quoted scalar.\n"
|
||||
|
||||
5
tests/yaml-1.2-spec-examples/example-2.19
Normal file
5
tests/yaml-1.2-spec-examples/example-2.19
Normal file
@@ -0,0 +1,5 @@
|
||||
canonical: 12345
|
||||
decimal: +12345
|
||||
octal: 0o14
|
||||
hexadecimal: 0xC
|
||||
|
||||
3
tests/yaml-1.2-spec-examples/example-2.2
Normal file
3
tests/yaml-1.2-spec-examples/example-2.2
Normal file
@@ -0,0 +1,3 @@
|
||||
hr: 65 # Home runs
|
||||
avg: 0.278 # Batting average
|
||||
rbi: 147 # Runs Batted In
|
||||
5
tests/yaml-1.2-spec-examples/example-2.20
Normal file
5
tests/yaml-1.2-spec-examples/example-2.20
Normal file
@@ -0,0 +1,5 @@
|
||||
canonical: 1.23015e+3
|
||||
exponential: 12.3015e+02
|
||||
fixed: 1230.15
|
||||
negative infinity: -.inf
|
||||
not a number: .NaN
|
||||
3
tests/yaml-1.2-spec-examples/example-2.21
Normal file
3
tests/yaml-1.2-spec-examples/example-2.21
Normal file
@@ -0,0 +1,3 @@
|
||||
null:
|
||||
booleans: [ true, false ]
|
||||
string: '012345'
|
||||
4
tests/yaml-1.2-spec-examples/example-2.22
Normal file
4
tests/yaml-1.2-spec-examples/example-2.22
Normal file
@@ -0,0 +1,4 @@
|
||||
canonical: 2001-12-15T02:59:43.1Z
|
||||
iso8601: 2001-12-14t21:59:43.10-05:00
|
||||
spaced: 2001-12-14 21:59:43.10 -5
|
||||
date: 2002-12-14
|
||||
14
tests/yaml-1.2-spec-examples/example-2.23
Normal file
14
tests/yaml-1.2-spec-examples/example-2.23
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
not-date: !!str 2002-04-28
|
||||
|
||||
picture: !!binary |
|
||||
R0lGODlhDAAMAIQAAP//9/X
|
||||
17unp5WZmZgAAAOfn515eXv
|
||||
Pz7Y6OjuDg4J+fn5OTk6enp
|
||||
56enmleECcgggoBADs=
|
||||
|
||||
application specific tag: !something |
|
||||
The semantics of the tag
|
||||
above may be different for
|
||||
different documents.
|
||||
|
||||
14
tests/yaml-1.2-spec-examples/example-2.24
Normal file
14
tests/yaml-1.2-spec-examples/example-2.24
Normal file
@@ -0,0 +1,14 @@
|
||||
%TAG ! tag:clarkevans.com,2002:
|
||||
--- !shape
|
||||
# Use the ! handle for presenting
|
||||
# tag:clarkevans.com,2002:circle
|
||||
- !circle
|
||||
center: &ORIGIN {x: 73, y: 129}
|
||||
radius: 7
|
||||
- !line
|
||||
start: *ORIGIN
|
||||
finish: { x: 89, y: 102 }
|
||||
- !label
|
||||
start: *ORIGIN
|
||||
color: 0xFFEEBB
|
||||
text: Pretty vector drawing.
|
||||
7
tests/yaml-1.2-spec-examples/example-2.25
Normal file
7
tests/yaml-1.2-spec-examples/example-2.25
Normal file
@@ -0,0 +1,7 @@
|
||||
# Sets are represented as a
|
||||
# Mapping where each key is
|
||||
# associated with a null value
|
||||
--- !!set
|
||||
? Mark McGwire
|
||||
? Sammy Sosa
|
||||
? Ken Griff
|
||||
7
tests/yaml-1.2-spec-examples/example-2.26
Normal file
7
tests/yaml-1.2-spec-examples/example-2.26
Normal file
@@ -0,0 +1,7 @@
|
||||
# Ordered maps are represented as
|
||||
# A sequence of mappings, with
|
||||
# each mapping having one key
|
||||
--- !!omap
|
||||
- Mark McGwire: 65
|
||||
- Sammy Sosa: 63
|
||||
- Ken Griffy: 58
|
||||
29
tests/yaml-1.2-spec-examples/example-2.27
Normal file
29
tests/yaml-1.2-spec-examples/example-2.27
Normal file
@@ -0,0 +1,29 @@
|
||||
--- !<tag:clarkevans.com,2002:invoice>
|
||||
invoice: 34843
|
||||
date : 2001-01-23
|
||||
bill-to: &id001
|
||||
given : Chris
|
||||
family : Dumars
|
||||
address:
|
||||
lines: |
|
||||
458 Walkman Dr.
|
||||
Suite #292
|
||||
city : Royal Oak
|
||||
state : MI
|
||||
postal : 48046
|
||||
ship-to: *id001
|
||||
product:
|
||||
- sku : BL394D
|
||||
quantity : 4
|
||||
description : Basketball
|
||||
price : 450.00
|
||||
- sku : BL4438H
|
||||
quantity : 1
|
||||
description : Super Hoop
|
||||
price : 2392.00
|
||||
tax : 251.42
|
||||
total: 4443.52
|
||||
comments:
|
||||
Late afternoon is best.
|
||||
Backup contact is Nancy
|
||||
Billsmer @ 338-4338.
|
||||
29
tests/yaml-1.2-spec-examples/example-2.28
Normal file
29
tests/yaml-1.2-spec-examples/example-2.28
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
Time: 2001-11-23 15:01:42 -5
|
||||
User: ed
|
||||
Warning:
|
||||
This is an error message
|
||||
for the log file
|
||||
---
|
||||
Time: 2001-11-23 15:02:31 -5
|
||||
User: ed
|
||||
Warning:
|
||||
A slightly different error
|
||||
message.
|
||||
---
|
||||
Date: 2001-11-23 15:03:17 -5
|
||||
User: ed
|
||||
Fatal:
|
||||
Unknown variable "bar"
|
||||
Stack:
|
||||
- file: TopClass.py
|
||||
line: 23
|
||||
code: |
|
||||
x = MoreObject("345\n")
|
||||
- file: MoreClass.py
|
||||
line: 58
|
||||
code: |-
|
||||
foo = bar
|
||||
|
||||
|
||||
|
||||
8
tests/yaml-1.2-spec-examples/example-2.3
Normal file
8
tests/yaml-1.2-spec-examples/example-2.3
Normal file
@@ -0,0 +1,8 @@
|
||||
american:
|
||||
- Boston Red Sox
|
||||
- Detroit Tigers
|
||||
- New York Yankees
|
||||
national:
|
||||
- New York Mets
|
||||
- Chicago Cubs
|
||||
- Atlanta Braves
|
||||
8
tests/yaml-1.2-spec-examples/example-2.4
Normal file
8
tests/yaml-1.2-spec-examples/example-2.4
Normal file
@@ -0,0 +1,8 @@
|
||||
-
|
||||
name: Mark McGwire
|
||||
hr: 65
|
||||
avg: 0.278
|
||||
-
|
||||
name: Sammy Sosa
|
||||
hr: 63
|
||||
avg: 0.288
|
||||
5
tests/yaml-1.2-spec-examples/example-2.5
Normal file
5
tests/yaml-1.2-spec-examples/example-2.5
Normal file
@@ -0,0 +1,5 @@
|
||||
- [name , hr, avg ]
|
||||
- [Mark McGwire, 65, 0.278]
|
||||
- [Sammy Sosa , 63, 0.288]
|
||||
|
||||
|
||||
5
tests/yaml-1.2-spec-examples/example-2.6
Normal file
5
tests/yaml-1.2-spec-examples/example-2.6
Normal file
@@ -0,0 +1,5 @@
|
||||
Mark McGwire: {hr: 65, avg: 0.278}
|
||||
Sammy Sosa: {
|
||||
hr: 63,
|
||||
avg: 0.288
|
||||
}
|
||||
10
tests/yaml-1.2-spec-examples/example-2.7
Normal file
10
tests/yaml-1.2-spec-examples/example-2.7
Normal file
@@ -0,0 +1,10 @@
|
||||
# Ranking of 1998 home runs
|
||||
---
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
|
||||
# Team ranking
|
||||
---
|
||||
- Chicago Cubs
|
||||
- St Louis Cardinals
|
||||
10
tests/yaml-1.2-spec-examples/example-2.8
Normal file
10
tests/yaml-1.2-spec-examples/example-2.8
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
time: 20:03:20
|
||||
player: Sammy Sosa
|
||||
action: strike (miss)
|
||||
...
|
||||
---
|
||||
time: 20:03:47
|
||||
player: Sammy Sosa
|
||||
action: grand slam
|
||||
...
|
||||
8
tests/yaml-1.2-spec-examples/example-2.9
Normal file
8
tests/yaml-1.2-spec-examples/example-2.9
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
hr: # 1998 hr ranking
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
rbi:
|
||||
# 1998 rbi ranking
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
1
tests/yaml-1.2-spec-examples/example-5.1
Normal file
1
tests/yaml-1.2-spec-examples/example-5.1
Normal file
@@ -0,0 +1 @@
|
||||
# Comment only.
|
||||
2
tests/yaml-1.2-spec-examples/example-5.10
Normal file
2
tests/yaml-1.2-spec-examples/example-5.10
Normal file
@@ -0,0 +1,2 @@
|
||||
commercial-at: @text
|
||||
grave-accent: `text
|
||||
3
tests/yaml-1.2-spec-examples/example-5.11
Normal file
3
tests/yaml-1.2-spec-examples/example-5.11
Normal file
@@ -0,0 +1,3 @@
|
||||
|
|
||||
Line break (no glyph)
|
||||
Line break (glyphed)
|
||||
6
tests/yaml-1.2-spec-examples/example-5.12
Normal file
6
tests/yaml-1.2-spec-examples/example-5.12
Normal file
@@ -0,0 +1,6 @@
|
||||
# Tabs and spaces
|
||||
quoted: "Quoted "
|
||||
block: |
|
||||
void main() {
|
||||
printf("Hello, world!\n");
|
||||
}
|
||||
5
tests/yaml-1.2-spec-examples/example-5.13
Normal file
5
tests/yaml-1.2-spec-examples/example-5.13
Normal file
@@ -0,0 +1,5 @@
|
||||
"Fun with \\
|
||||
\" \a \b \e \f \
|
||||
\n \r \t \v \0 \
|
||||
\ \_ \N \L \P \
|
||||
\x41 \u0041 \U00000041"
|
||||
3
tests/yaml-1.2-spec-examples/example-5.14
Normal file
3
tests/yaml-1.2-spec-examples/example-5.14
Normal file
@@ -0,0 +1,3 @@
|
||||
Bad escapes:
|
||||
"\c
|
||||
\xq-"
|
||||
3
tests/yaml-1.2-spec-examples/example-5.2
Normal file
3
tests/yaml-1.2-spec-examples/example-5.2
Normal file
@@ -0,0 +1,3 @@
|
||||
- Invalid use of BOM
|
||||
|
||||
- Inside a document.
|
||||
7
tests/yaml-1.2-spec-examples/example-5.3
Normal file
7
tests/yaml-1.2-spec-examples/example-5.3
Normal file
@@ -0,0 +1,7 @@
|
||||
sequence:
|
||||
- one
|
||||
- two
|
||||
mapping:
|
||||
? sky
|
||||
: blue
|
||||
sea : green
|
||||
2
tests/yaml-1.2-spec-examples/example-5.4
Normal file
2
tests/yaml-1.2-spec-examples/example-5.4
Normal file
@@ -0,0 +1,2 @@
|
||||
sequence: [ one, two, ]
|
||||
mapping: { sky: blue, sea: green }
|
||||
1
tests/yaml-1.2-spec-examples/example-5.5
Normal file
1
tests/yaml-1.2-spec-examples/example-5.5
Normal file
@@ -0,0 +1 @@
|
||||
# Comment only.
|
||||
2
tests/yaml-1.2-spec-examples/example-5.6
Normal file
2
tests/yaml-1.2-spec-examples/example-5.6
Normal file
@@ -0,0 +1,2 @@
|
||||
anchored: !local &anchor value
|
||||
alias: *anchor
|
||||
6
tests/yaml-1.2-spec-examples/example-5.7
Normal file
6
tests/yaml-1.2-spec-examples/example-5.7
Normal file
@@ -0,0 +1,6 @@
|
||||
literal: |
|
||||
some
|
||||
text
|
||||
folded: >
|
||||
some
|
||||
text
|
||||
2
tests/yaml-1.2-spec-examples/example-5.8
Normal file
2
tests/yaml-1.2-spec-examples/example-5.8
Normal file
@@ -0,0 +1,2 @@
|
||||
single: 'text'
|
||||
double: "text"
|
||||
2
tests/yaml-1.2-spec-examples/example-5.9
Normal file
2
tests/yaml-1.2-spec-examples/example-5.9
Normal file
@@ -0,0 +1,2 @@
|
||||
%YAML 1.2
|
||||
--- text
|
||||
12
tests/yaml-1.2-spec-examples/example-6.1
Normal file
12
tests/yaml-1.2-spec-examples/example-6.1
Normal file
@@ -0,0 +1,12 @@
|
||||
# Leading comment line spaces are
|
||||
# neither content nor indentation.
|
||||
|
||||
Not indented:
|
||||
By one space: |
|
||||
By four
|
||||
spaces
|
||||
Flow style: [ # Leading spaces
|
||||
By two, # in flow style
|
||||
Also by two, # are neither
|
||||
Still by two # content nor
|
||||
] # indentation.
|
||||
3
tests/yaml-1.2-spec-examples/example-6.10
Normal file
3
tests/yaml-1.2-spec-examples/example-6.10
Normal file
@@ -0,0 +1,3 @@
|
||||
# Comment
|
||||
|
||||
|
||||
4
tests/yaml-1.2-spec-examples/example-6.11
Normal file
4
tests/yaml-1.2-spec-examples/example-6.11
Normal file
@@ -0,0 +1,4 @@
|
||||
key: # Comment
|
||||
# lines
|
||||
value
|
||||
|
||||
6
tests/yaml-1.2-spec-examples/example-6.12
Normal file
6
tests/yaml-1.2-spec-examples/example-6.12
Normal file
@@ -0,0 +1,6 @@
|
||||
{ first: Sammy, last: Sosa }:
|
||||
# Statistics:
|
||||
hr: # Home runs
|
||||
65
|
||||
avg: # Average
|
||||
0.278
|
||||
3
tests/yaml-1.2-spec-examples/example-6.13
Normal file
3
tests/yaml-1.2-spec-examples/example-6.13
Normal file
@@ -0,0 +1,3 @@
|
||||
%FOO bar baz # Should be ignored
|
||||
# with a warning.
|
||||
--- "foo"
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user