mirror of
https://github.com/certbot/certbot.git
synced 2026-05-28 04:34:11 -04:00
Class inheritance based approach to distro specific overrides.
How it works:
The certbot-apache plugin entrypoint has been changed to entrypoint.ENTRYPOINT which is a variable containing appropriate override class for system, if available.
Override classes register themselves using decorator override.register() which takes a list of distribution fingerprints (ID & LIKE variables in /etc/os-release, or platform.linux_distribution() as a fallback). These end up as keys in dict override.OVERRIDE_CLASSES and values for the keys are references to the class that called the decorator, hence allowing self-registration of override classes when they are imported. The only file importing these override classes is entrypoint.py, so adding new override classes would need only one import in addition to the actual override class file.
Generic changes:
Parser initialization has been moved to separate class method, allowing easy override where needed.
Cleaned up configurator.py a bit, and moved some helper functions to newly created apache_util.py
Split Debian specific code from configurator.py to debian_override.py
Changed define_cmd to apache_cmd because the parameters are for every distribution supporting this behavior, and we're able to use the value to build the additional configuration dump commands.
Moved add_parser_mod() from configurator to parser add_mod()
Added two new configuration dump parsing methods to update_runtime_variables() in parser: update_includes() and update_modules().
Changed init_modules() in parser to accommodate the changes above. (ie. don't throw existing self.modules out).
Moved OS based constants to their respective override classes.
Refactored configurator class discovery in tests to help easier test case creation using distribution based override configurator class.
tests.util.get_apache_configurator() now takes keyword argument os_info which is string of the desired mock OS fingerprint response that's used for picking the right override class.
This PR includes two major generic additions that should vastly improve our parsing accuracy and quality:
Includes are parsed from config dump from httpd binary. This is mandatory for some distributions (Like OpenSUSE) to get visibility over the whole configuration tree because of Include statements passed on in command line, and not via root httpd.conf file.
Modules are parsed from config dump from httpd binary. This lets us jump into correct IfModule directives if for some reason we have missed the module availability (because of one being included on command line or such).
Distribution specific changes
Because of the generic changes, there are two distributions (or distribution families) that do not provide such functionality, so it had to be overridden in their respective override files. These distributions are:
CentOS, because it deliberately limits httpd binary stdout using SELinux as a feature. We are doing opportunistic config dumps here however, in case SELinux enforcing is off.
Gentoo, because it does not provide a way to invoke httpd with command line parsed from its specific configuration file. Gentoo relies heavily on Define statements that are passed over from APACHE2_OPTS variable /etc/conf.d/apache2 file and most of the configuration in root Apache configuration are dependent on these values.
Debian
Moved the Debian specific parts from configurator.py to Debian specific override.
CentOS
Parsing of /etc/sysconfig/httpd file for additional Define statements. This could hold other parameters too, but parsing everything off it would require a full Apache lexer. For CLI parameters, I think Defines are the most common ones. This is done in addition of opportunistic parsing of httpd binary config dump.
Added CentOS default Apache configuration tree for realistic test cases.
Gentoo
Parsing Defines from /etc/conf.d/apache2 variable APACHE2_OPTS, which holds additional Define statements to enable certain functionalities, enabling parts of the configuration in the Apache2 DOM. This is done instead of trying to parse httpd binary configuration dumps.
Added default Apache configuration from Gentoo to testdata, including /etc/conf.d/apache2 file for realistic test cases.
* Distribution specific override functionality based on class inheritance
* Need to patch get_systemd_os_like to as travis has proper os-release
* Added pydoc
* Move parser initialization to a method and fix Python 3 __new__ errors
* Parser changes to parse HTTPD config
* Try to get modules and includes from httpd process for better visibility over the configuration
* Had to disable duplicate-code because of test setup (PyCQA/pylint/issues/214)
* CentOS tests and linter fixes
* Gentoo override, tests and linter fixes
* Mock the process call in all the tests that require it
* Fix CentOS test mock
* Restore reseting modules list functionality for cleanup
* Move OS fingerprinting and constant mocks to parent class
* Fixes requested in review
* New entrypoint structure and started moving OS constants to override classes
* OS constants move continued, test and linter fixes
* Removed dead code
* Apache compatibility test changest to reflect OS constant restructure
* Test fix
* Requested changes
* Moved Debian specific tests to own test file
* Removed decorator based override class registration in favor of entrypoint dict
* Fix for update_includes for some versions of Augeas
* Take fedora fix into account in tests
* Review fixes
338 lines
10 KiB
INI
338 lines
10 KiB
INI
[MASTER]
|
|
|
|
# use as many jobs as there are cores
|
|
jobs=0
|
|
|
|
# Specify a configuration file.
|
|
#rcfile=
|
|
|
|
# Python code to execute, usually for sys.path manipulation such as
|
|
# pygtk.require().
|
|
#init-hook=
|
|
|
|
# Profiled execution.
|
|
profile=no
|
|
|
|
# Add files or directories to the blacklist. They should be base names, not
|
|
# paths.
|
|
ignore=CVS
|
|
|
|
# Pickle collected data for later comparisons.
|
|
persistent=yes
|
|
|
|
# List of plugins (as comma separated values of python modules names) to load,
|
|
# usually to register additional checkers.
|
|
load-plugins=linter_plugin
|
|
|
|
|
|
[MESSAGES CONTROL]
|
|
|
|
# Enable the message, report, category or checker with the given id(s). You can
|
|
# either give multiple identifier separated by comma (,) or put this option
|
|
# multiple time. See also the "--disable" option for examples.
|
|
#enable=
|
|
|
|
# Disable the message, report, category or checker with the given id(s). You
|
|
# can either give multiple identifiers separated by comma (,) or put this
|
|
# option multiple times (only on the command line, not in the configuration
|
|
# file where it should appear only once).You can also use "--disable=all" to
|
|
# disable everything first and then reenable specific checks. For example, if
|
|
# you want to run only the similarities checker, you can use "--disable=all
|
|
# --enable=similarities". If you want to run only the classes checker, but have
|
|
# no Warning level messages displayed, use"--disable=all --enable=classes
|
|
# --disable=W"
|
|
disable=fixme,locally-disabled,abstract-class-not-used,abstract-class-little-used,bad-continuation,too-few-public-methods,no-self-use,invalid-name,too-many-instance-attributes,cyclic-import,duplicate-code
|
|
# abstract-class-not-used cannot be disabled locally (at least in
|
|
# pylint 1.4.1), same for abstract-class-little-used
|
|
|
|
|
|
[REPORTS]
|
|
|
|
# Set the output format. Available formats are text, parseable, colorized, msvs
|
|
# (visual studio) and html. You can also give a reporter class, eg
|
|
# mypackage.mymodule.MyReporterClass.
|
|
output-format=text
|
|
|
|
# Put messages in a separate file for each module / package specified on the
|
|
# command line instead of printing them on stdout. Reports (if any) will be
|
|
# written in a file name "pylint_global.[txt|html]".
|
|
files-output=no
|
|
|
|
# Tells whether to display a full report or only the messages
|
|
reports=yes
|
|
|
|
# Python expression which should return a note less than 10 (10 is the highest
|
|
# note). You have access to the variables errors warning, statement which
|
|
# respectively contain the number of errors / warnings messages and the total
|
|
# number of statements analyzed. This is used by the global evaluation report
|
|
# (RP0004).
|
|
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
|
|
|
|
# Add a comment according to your evaluation note. This is used by the global
|
|
# evaluation report (RP0004).
|
|
comment=no
|
|
|
|
# Template used to display messages. This is a python new-style format string
|
|
# used to format the message information. See doc for all details
|
|
#msg-template=
|
|
|
|
|
|
[BASIC]
|
|
|
|
# Required attributes for module, separated by a comma
|
|
required-attributes=
|
|
|
|
# List of builtins function names that should not be used, separated by a comma
|
|
bad-functions=map,filter,apply,input,file
|
|
|
|
# Good variable names which should always be accepted, separated by a comma
|
|
good-names=f,i,j,k,ex,Run,_,fd,logger
|
|
|
|
# Bad variable names which should always be refused, separated by a comma
|
|
bad-names=foo,bar,baz,toto,tutu,tata
|
|
|
|
# Colon-delimited sets of names that determine each other's naming style when
|
|
# the name regexes allow several styles.
|
|
name-group=
|
|
|
|
# Include a hint for the correct naming format with invalid-name
|
|
include-naming-hint=no
|
|
|
|
# Regular expression matching correct function names
|
|
function-rgx=[a-z_][a-z0-9_]{2,40}$
|
|
|
|
# Naming hint for function names
|
|
function-name-hint=[a-z_][a-z0-9_]{2,40}$
|
|
|
|
# Regular expression matching correct variable names
|
|
variable-rgx=[a-z_][a-z0-9_]{1,30}$
|
|
|
|
# Naming hint for variable names
|
|
variable-name-hint=[a-z_][a-z0-9_]{2,30}$
|
|
|
|
# Regular expression matching correct constant names
|
|
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
|
|
|
|
# Naming hint for constant names
|
|
const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
|
|
|
|
# Regular expression matching correct attribute names
|
|
attr-rgx=[a-z_][a-z0-9_]{2,30}$
|
|
|
|
# Naming hint for attribute names
|
|
attr-name-hint=[a-z_][a-z0-9_]{2,30}$
|
|
|
|
# Regular expression matching correct argument names
|
|
argument-rgx=[a-z_][a-z0-9_]{2,30}$
|
|
|
|
# Naming hint for argument names
|
|
argument-name-hint=[a-z_][a-z0-9_]{2,30}$
|
|
|
|
# Regular expression matching correct class attribute names
|
|
class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
|
|
|
|
# Naming hint for class attribute names
|
|
class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
|
|
|
|
# Regular expression matching correct inline iteration names
|
|
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
|
|
|
|
# Naming hint for inline iteration names
|
|
inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
|
|
|
|
# Regular expression matching correct class names
|
|
class-rgx=[A-Z_][a-zA-Z0-9]+$
|
|
|
|
# Naming hint for class names
|
|
class-name-hint=[A-Z_][a-zA-Z0-9]+$
|
|
|
|
# Regular expression matching correct module names
|
|
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
|
|
|
|
# Naming hint for module names
|
|
module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
|
|
|
|
# Regular expression matching correct method names
|
|
method-rgx=[a-z_][a-z0-9_]{2,50}$
|
|
|
|
# Naming hint for method names
|
|
method-name-hint=[a-z_][a-z0-9_]{2,50}$
|
|
|
|
# Regular expression which should only match function or class names that do
|
|
# not require a docstring.
|
|
no-docstring-rgx=(__.*__)|(test_[A-Za-z0-9_]*)|(_.*)|(.*Test$)
|
|
|
|
# Minimum line length for functions/classes that require docstrings, shorter
|
|
# ones are exempt.
|
|
docstring-min-length=-1
|
|
|
|
|
|
[MISCELLANEOUS]
|
|
|
|
# List of note tags to take in consideration, separated by a comma.
|
|
notes=FIXME,XXX,TODO
|
|
|
|
|
|
[LOGGING]
|
|
|
|
# Logging modules to check that the string format arguments are in logging
|
|
# function parameter format
|
|
logging-modules=logging,logger
|
|
|
|
|
|
[VARIABLES]
|
|
|
|
# Tells whether we should check for unused import in __init__ files.
|
|
init-import=no
|
|
|
|
# A regular expression matching the name of dummy variables (i.e. expectedly
|
|
# not used).
|
|
dummy-variables-rgx=(unused)?_.*|dummy
|
|
|
|
# List of additional names supposed to be defined in builtins. Remember that
|
|
# you should avoid to define new builtins when possible.
|
|
additional-builtins=
|
|
|
|
|
|
[SIMILARITIES]
|
|
|
|
# Minimum lines number of a similarity.
|
|
min-similarity-lines=6
|
|
|
|
# Ignore comments when computing similarities.
|
|
ignore-comments=yes
|
|
|
|
# Ignore docstrings when computing similarities.
|
|
ignore-docstrings=yes
|
|
|
|
# Ignore imports when computing similarities.
|
|
ignore-imports=yes
|
|
|
|
|
|
[FORMAT]
|
|
|
|
# Maximum number of characters on a single line.
|
|
max-line-length=100
|
|
|
|
# Regexp for a line that is allowed to be longer than the limit.
|
|
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
|
|
|
|
# Allow the body of an if to be on the same line as the test if there is no
|
|
# else.
|
|
single-line-if-stmt=no
|
|
|
|
# List of optional constructs for which whitespace checking is disabled
|
|
no-space-check=trailing-comma
|
|
|
|
# Maximum number of lines in a module
|
|
max-module-lines=1250
|
|
|
|
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
|
|
# tab).
|
|
indent-string=' '
|
|
|
|
# Number of spaces of indent required inside a hanging or continued line.
|
|
# This does something silly/broken...
|
|
#indent-after-paren=4
|
|
|
|
|
|
[TYPECHECK]
|
|
|
|
# Tells whether missing members accessed in mixin class should be ignored. A
|
|
# mixin class is detected if its name ends with "mixin" (case insensitive).
|
|
ignore-mixin-members=yes
|
|
|
|
# List of module names for which member attributes should not be checked
|
|
# (useful for modules/projects where namespaces are manipulated during runtime
|
|
# and thus existing member attributes cannot be deduced by static analysis
|
|
ignored-modules=pkg_resources,confargparse,argparse,six.moves,six.moves.urllib
|
|
# import errors ignored only in 1.4.4
|
|
# https://bitbucket.org/logilab/pylint/commits/cd000904c9e2
|
|
|
|
# List of classes names for which member attributes should not be checked
|
|
# (useful for classes with attributes dynamically set).
|
|
ignored-classes=SQLObject
|
|
|
|
# When zope mode is activated, add a predefined set of Zope acquired attributes
|
|
# to generated-members.
|
|
zope=yes
|
|
|
|
# List of members which are set dynamically and missed by pylint inference
|
|
# system, and so shouldn't trigger E0201 when accessed. Python regular
|
|
# expressions are accepted.
|
|
generated-members=REQUEST,acl_users,aq_parent
|
|
|
|
|
|
[IMPORTS]
|
|
|
|
# Deprecated modules which should not be used, separated by a comma
|
|
deprecated-modules=regsub,TERMIOS,Bastion,rexec
|
|
|
|
# Create a graph of every (i.e. internal and external) dependencies in the
|
|
# given file (report RP0402 must not be disabled)
|
|
import-graph=
|
|
|
|
# Create a graph of external dependencies in the given file (report RP0402 must
|
|
# not be disabled)
|
|
ext-import-graph=
|
|
|
|
# Create a graph of internal dependencies in the given file (report RP0402 must
|
|
# not be disabled)
|
|
int-import-graph=
|
|
|
|
|
|
[CLASSES]
|
|
|
|
# List of interface methods to ignore, separated by a comma. This is used for
|
|
# instance to not check methods defined in Zope's Interface base class.
|
|
ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by,implementedBy,providedBy
|
|
|
|
# List of method names used to declare (i.e. assign) instance attributes.
|
|
defining-attr-methods=__init__,__new__,setUp
|
|
|
|
# List of valid names for the first argument in a class method.
|
|
valid-classmethod-first-arg=cls
|
|
|
|
# List of valid names for the first argument in a metaclass class method.
|
|
valid-metaclass-classmethod-first-arg=mcs
|
|
|
|
|
|
[DESIGN]
|
|
|
|
# Maximum number of arguments for function / method
|
|
max-args=6
|
|
|
|
# Argument names that match this expression will be ignored. Default to name
|
|
# with leading underscore
|
|
ignored-argument-names=_.*
|
|
|
|
# Maximum number of locals for function / method body
|
|
max-locals=15
|
|
|
|
# Maximum number of return / yield for function / method body
|
|
max-returns=6
|
|
|
|
# Maximum number of branch for function / method body
|
|
max-branches=12
|
|
|
|
# Maximum number of statements in function / method body
|
|
max-statements=50
|
|
|
|
# Maximum number of parents for a class (see R0901).
|
|
max-parents=12
|
|
|
|
# Maximum number of attributes for a class (see R0902).
|
|
max-attributes=7
|
|
|
|
# Minimum number of public methods for a class (see R0903).
|
|
min-public-methods=2
|
|
|
|
# Maximum number of public methods for a class (see R0904).
|
|
max-public-methods=20
|
|
|
|
|
|
[EXCEPTIONS]
|
|
|
|
# Exceptions that will emit a warning when being caught. Defaults to
|
|
# "Exception"
|
|
overgeneral-exceptions=Exception
|