--- /dev/null
+.cache
+.coverage
+.eggs
+__pycache__
+dist
+env
+htmlcov
+plugins/__pycache__
+MANIFEST
+Margebot.egg-info
+*~
--- /dev/null
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# 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=
+
+# Use multiple processes to speed up Pylint.
+jobs=1
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code
+extension-pkg-whitelist=
+
+# Allow optimization of some AST trees. This will activate a peephole AST
+# optimizer, which will apply various small optimizations. For instance, it can
+# be used to obtain the result of joining multiple strings with the addition
+# operator. Joining a lot of strings can lead to a maximum recursion error in
+# Pylint and this flag can prevent that. It has one side effect, the resulting
+# AST will be different than the one from reality.
+optimize-ast=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# 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=import-star-module-level,old-octal-literal,oct-method,print-statement,unpacking-in-except,parameter-unpacking,backtick,old-raise-syntax,old-ne-operator,long-suffix,dict-view-method,dict-iter-method,metaclass-assignment,next-method-called,raising-string,indexing-exception,raw_input-builtin,long-builtin,file-builtin,execfile-builtin,coerce-builtin,cmp-builtin,buffer-builtin,basestring-builtin,apply-builtin,filter-builtin-not-iterating,using-cmp-argument,useless-suppression,range-builtin-not-iterating,suppressed-message,no-absolute-import,old-division,cmp-method,reload-builtin,zip-builtin-not-iterating,intern-builtin,unichr-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,input-builtin,round-builtin,hex-method,nonzero-method,map-builtin-not-iterating,line-too-long,no-name-in-module,input-error,missing-super-argument,no-self-use,too-many-locals,too-many-branches,import-error,locally-disabled,locally-enabled,too-many-ancestors,useless-super-delegation,logging-format-interpolation
+
+
+[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)
+
+# 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]
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,input
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,ex,Run,_
+
+# 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,30}$
+
+# Naming hint for function names
+function-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression matching correct variable names
+variable-rgx=[a-z_][a-z0-9_]{2,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,30}$
+
+# Naming hint for method names
+method-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+
+[ELIF]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+
+[SPELLING]
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[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. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=trailing-comma,dict-separator
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# 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.
+indent-after-paren=4
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+
+[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. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set). This supports can work
+# with qualified names.
+ignored-classes=
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[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=_$|dummy
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,_cb
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# 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=7
+
+# 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
+
+# Maximum number of boolean expressions in a if statement
+max-bool-expr=5
+
+
+[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 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
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,_fields,_replace,_source,_make
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception
--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
-_margebot_ -- I remind you about outstanding Gitlab merge requests
+Marge: I remind you about outstanding Gitlab merge requests
+
+Use:
+ - In gitlab:
+ - Add a 'notify_<roomname>' label to the projects you want margebot to report on.
+ - In errbot:
+ - Add <roomname>@domain to the CHATROOM_PRESENCE list in config.py for rooms margebot should join
[Core]
Name = Marge
Module = marge
+DependsOn = Webserver
[Documentation]
Description = Marge helps with Gitlab merge requests
-import re
+"""
+Margebot: A Errbot Plugin for Gitlab MR reminders
+"""
from datetime import datetime, timezone
+from time import sleep
from dateutil import parser
from dateutil.tz import tzutc
-from dateutil.relativedelta import *
+from dateutil.relativedelta import relativedelta
from errbot import BotPlugin, botcmd, webhook
-from errbot.backends import xmpp
from errcron.bot import CrontabMixin
-from time import sleep
import gitlab
+
def deltastr(any_delta):
+ """
+ Output a datetime delta in the format "x days, y hours, z minutes ago"
+ """
l_delta = []
- (days, hours, mins) = (any_delta.days, any_delta.seconds//3600, (any_delta.seconds//60)%60)
+ days = any_delta.days
+ hours = any_delta.seconds // 3600
+ mins = (any_delta.seconds // 60) % 60
- for (k,v) in {"day": days, "hour": hours, "minute": mins}.items():
- if v == 1:
- l_delta.append("1 " + k)
- elif v > 1:
- l_delta.append("{} {}s".format(v, k))
+ for (key, val) in [("day", days), ("hour", hours), ("minute", mins)]:
+ if val == 1:
+ l_delta.append("1 " + key)
+ elif val > 1:
+ l_delta.append("{} {}s".format(val, key))
- return ",".join(l_delta) + " ago"
+ if l_delta == []:
+ retval = "now"
+ else:
+ retval = ", ".join(l_delta) + " ago"
+ return retval
class Marge(BotPlugin, CrontabMixin):
def __init__(self, *args, **kwargs):
self.git_host = None
self.chatroom_host = None
+ self.gitlab = None
+ self.soak_delta = None
super().__init__(*args, **kwargs)
def get_configuration_template(self):
"""
GITLAB_HOST: Host name of your gitlab server
- GITLAB_ADMIN_TOKEN: PAT from an admin's https://${GIT_HOST}/profile/personal_access_tokens page.
+ GITLAB_ADMIN_TOKEN: PAT from an admin's https://${GIT_HOST}/profile/personal_access_tokens.
CHATROOM_HOST: Chatroom host. Usually 'chatroom' + FQDN of Jabber server
CRONTAB: Schedule of automated merge request checks in '%M %H %d %m %w' format
VERIFY_SSL : True, False, or path to CA cert to verify cert
CRONTAB_SOAK_HOURS : Don't send out reminders about MRs opened less than this many hours
- """
+ """
return {'GITLAB_HOST': 'gitlab.example.com',
- 'GITLAB_ADMIN_TOKEN' : 'gitlab-admin-user-private-token',
+ 'GITLAB_ADMIN_TOKEN': 'gitlab-admin-user-private-token',
'CHATROOM_HOST': 'conference.jabber.example.com',
- 'CRONTAB' : '0 11,17 * * *',
- 'VERIFY_SSL' : True,
- 'CRONTAB_SOAK_HOURS' : 1}
+ 'CRONTAB': '0 11,17 * * *',
+ 'VERIFY_SSL': True,
+ 'CRONTAB_SOAK_HOURS': 1}
def check_configuration(self, configuration):
+ """
+ Check that the plugin has been configured properly
+ """
super().check_configuration(configuration)
def activate(self):
+ """
+ Initialization done when the plugin is activated
+ """
if not self.config:
self.log.info('Margebot is not configured. Forbid activation')
return
self.git_host = self.config['GITLAB_HOST']
self.chatroom_host = self.config['CHATROOM_HOST']
- Marge.CRONTAB = ['{} .crontab_hook'.format(self.config['CRONTAB']) ]
- self.gitlab = gitlab.Gitlab(self.git_host, self.config['GITLAB_ADMIN_TOKEN'], verify_ssl=self.config['VERIFY_SSL'])
+ Marge.CRONTAB = ['{} .crontab_hook'.format(self.config['CRONTAB'])]
+ gitlab_auth_token = self.config['GITLAB_ADMIN_TOKEN']
+ verify_ssl = self.config['VERIFY_SSL']
+ self.gitlab = gitlab.Gitlab(self.git_host, gitlab_auth_token, verify_ssl=verify_ssl)
self.activate_crontab()
- self.soak_delta = relativedelta( hours = self.config['CRONTAB_SOAK_HOURS'])
+ self.soak_delta = relativedelta(hours=self.config['CRONTAB_SOAK_HOURS'])
super().activate()
def deactivate(self):
+ """
+ Anything that needs to be tore down when the plugin is deactivated goes here.
+ """
super().deactivate()
@webhook('/margebot/<rooms>/')
Webhook that listens on http://<server>:<port>/gitlab
"""
- self.log.info('margebot webhook request: {}'.format(request))
- self.log.info('margebot webhook rooms {}'.format(rooms))
+ self.log.info("webhook: request: {}, rooms: {}".format(request, rooms))
+ self.log.info("state: {}".format(request['object_attributes']['state']))
# verify it's a merge request
if request['object_kind'] != 'merge_request':
- self.log.error('expecting object_kind of merge_request but got {}'.format(request['object_kind']))
- self.log.error('request: {}'.format(request))
- elif request['object_attributes']['state'] == 'opened':
-
- # TODO:
- # - check for reopened / request['object_attributes']['action'] == 'reopn'
- # (there's no 'action': 'opened' for MRs are created...
- # - pop open_mrs when MRs are closed (action == close / state == closed
+ self.log.error('unexpecting object_kind: {}'.format(request['object_kind']))
+ elif 'opened' in request['object_attributes']['state']:
if request['object_attributes']['work_in_progress']:
- wip = "WIP"
+ wip = "WIP "
else:
wip = ""
url = request['project']['homepage']
- state = request['object_attributes']['state']
title = request['object_attributes']['title']
author_id = request['object_attributes']['author_id'] # map this to user name ...
author = self.gitlab.getuser(author_id)
- author_name = author['username']
+ if author:
+ author_name = author['username']
+ else:
+ self.log.info("unexpected author_id {}".format(author_id))
+ author_name = author_id
target_project_id = request['object_attributes']['target_project_id']
iid = request['object_attributes']['iid']
- user_name = request['user']['username'] # will this always be Administrator ?
-
- msg_template = "New Review: {} has opened a new {} MR: \"{}\"\n{}/merge_requests/{}"
+ msg_template = "New Review: {} has opened a new {}MR: \"{}\"\n{}/merge_requests/{}"
msg = msg_template.format(author_name, wip, title, url, iid)
for a_room in rooms.split(','):
empty_dict = {}
self['OPEN_MRS'] = empty_dict
- with self.mutable('OPEN_MRS') as open_mrs:
- open_mrs[(target_project_id, iid, rooms)] = True
+ open_mrs = self['OPEN_MRS']
+ self.log.info("webhook: Saving ({}, {}, {})".format(target_project_id, iid, rooms))
+ open_mrs[(target_project_id, id, rooms)] = True
+ self['OPEN_MRS'] = open_mrs
return "OK"
def mr_status_msg(self, a_mr, author=None):
+ """
+ Create the merge request status message
+ """
self.log.info("mr_status_msg: a_mr: {}".format(a_mr))
now = datetime.now(timezone.utc)
creation_time = parser.parse(a_mr['created_at'], tzinfos=tzutc)
self.log.info("times: {}, {}, {}".format(creation_time, self.soak_delta, now))
if creation_time + self.soak_delta > now:
- info_msg = "skipping: MR <{},{}> was opened less than {} hours ago".format(project, iid, soak_hours)
- self.log.info(info_msg)
+ project = a_mr['project']
+ iid = a_mr['iid']
+ soak_hours = self.config['CRONTAB_SOAK_HOURS']
+ info_template = "skipping: MR <{},{}> was opened less than {} hours ago"
+ info_msg = info_template.format(project, iid, soak_hours)
+ self.log.info(info_msg)
return None
str_open_since = deltastr(now - creation_time)
else:
authored = False
- # TODO: Include the count of opened MR notes (does the API show resolved state ??)
-
- # getapprovals is only available in GitLab 8.9 EE or greater (not the open source CE version)
+ # getapprovals is only available in GitLab 8.9 EE or greater
+ # (not the open source CE version)
# approvals = self.gitlab.getapprovals(a_mr['id'])
# also_approved = ""
# for approved in approvals['approved_by']:
upvotes = a_mr['upvotes']
msg = "{} (opened {})".format(a_mr['web_url'], str_open_since)
if upvotes >= 2:
- msg += ": Has 2+ upvotes / Could be merge in now"
+ msg += ": Has 2+ upvotes and could be merged in now"
if warning != "":
- msg += " except {}".format(a_mr['web_url'], str_open_since, warning)
+ msg += " except {}.".format(warning)
else:
- msg += "."
+ msg += "."
elif upvotes == 1:
if authored:
else:
msg += ": Waiting for another upvote"
if warning != "":
- msg += "but {}.".format(warning)
+ msg += " but {}.".format(warning)
else:
msg += "."
else:
msg += ": No upvotes, please review"
if warning != "":
- msg += "but {}".format(warning)
+ msg += " but {}.".format(warning)
else:
msg += "."
- return((creation_time, msg))
-
+ return (creation_time, msg)
def crontab_hook(self, polled_time):
"""
for a_room in rooms:
reminder_msg[a_room.node] = []
- msgs = ""
+ msgs = ""
still_open_mrs = {}
# Let's walk through the MRs we've seen already:
- with self.mutable('OPEN_MRS') as open_mrs:
- for (project, iid, notify_rooms) in open_mrs:
+ open_mrs = self['OPEN_MRS']
- # Lookup the MR from the project/iid
- a_mr = self.gitlab.getmergerequest(project, iid)
+ for (project, iid, notify_rooms) in open_mrs:
- self.log.info("a_mr: {} {} {} {}".format(project, iid, notify_rooms, a_mr['state']))
+ # Lookup the MR from the project/iid
+ a_mr = self.gitlab.getmergerequest(project, iid)
- # If the MR is no longer open, skip to the next MR,
- # and don't include this MR in the next check
- if a_mr['state'] != 'opened':
- continue
- else:
- still_open_mrs[(project, iid, notify_rooms)] = True
+ self.log.info("a_mr: {} {} {} {}".format(project, iid, notify_rooms, a_mr['state']))
- msg_tuple = self.mr_status_msg(a_mr)
- if msg_tuple is None:
- continue
+ # If the MR is no longer open, skip to the next MR,
+ # and don't include this MR in the next check
+ if 'opened' not in a_mr['state']:
+ continue
+ else:
+ still_open_mrs[(project, iid, notify_rooms)] = True
+
+ msg_tuple = self.mr_status_msg(a_mr)
+ if msg_tuple is None:
+ continue
+
+ for a_room in notify_rooms.split(','):
+ reminder_msg[a_room].append(msg_tuple)
- for a_room in notify_rooms.split(','):
- reminder_msg[a_room].append(msg_tuple)
+ self['OPEN_MRS'] = open_mrs
# Remind each of the rooms about open MRs
for a_room, room_msg_list in reminder_msg.items():
- if room_msg != []:
+ if room_msg_list != []:
+
+ # sort by the creation time
+ sorted_room_msg_list = sorted(room_msg_list, key=lambda x: x[0])
+
+ # extract the msgs from the tuple list
+ msgs = [x[1] for x in sorted_room_msg_list]
- sorted_room_msg_list = sorted(room_msg_list, key=lambda x: x[0]) # sort by the creation time
- msgs = [x[1] for x in sorted_room_msg_list] # extract the msgs from the tuple list
- room_msg = "\n".join(msgs) # join those msgs together.
+ # join those msgs together.
+ room_msg = "\n".join(msgs)
if self.config:
msg_template = "These MRs need some attention:{}\n"
- msg_template += "You can get an updated list with the '/msg MargeB !reviews' command."
+ msg_template += "You can get an updated list with the !reviews command."
+ to_room = a_room + '@' + self.config['CHATROOM_HOST']
msg = msg_template.format(room_msg)
- self.send(self.build_identifier(a_room + '@' + self.config['CHATROOM_HOST']), msg)
+ self.send(self.build_identifier(to_room), msg)
self['OPEN_MRS'] = still_open_mrs
@botcmd()
- def reviews(self, msg, args): # a command callable with !mrs
+ def reviews(self, msg, args):
"""
Returns a list of MRs that are waiting for some luv.
Also returns a list of MRs that have had enough luv but aren't merged in yet.
"""
- ## Sending directly to Margbot: sender in the form sender@....
- ## Sending to a chatroom: snder in the form room@rooms/sender
+ # Sending directly to Margbot: sender in the form sender@....
+ # Sending to a chatroom: snder in the form room@rooms/sender
- if msg.frm.domain == self.config['CHATROOM_HOST']:
- sender = msg.frm.resource
+ log_template = 'reviews: msg: {}, args: {}, \nmsg.frm: {}, \nmsg.msg.frm: {}, chatroom_host: {}'
+ self.log.info(log_template.format(msg, args, msg.frm.__dict__, dir(msg.frm), self.config['CHATROOM_HOST']))
+ self.log.info('reviews: bot mode: {}'.format(self._bot.mode))
+
+ if self._bot.mode == "xmpp":
+ if msg.frm.domain == self.config['CHATROOM_HOST']:
+ sender = msg.frm.resource
+ else:
+ sender = msg.frm.node
else:
- sender = msg.frm.node
+ sender = str(msg.frm).split('@')[0]
- if 'OPEN_MRS' not in self.keys():
+ keys = self.keys()
+ if 'OPEN_MRS' not in keys:
+ self.log.error('OPEN_MRS not in {}'.format(keys))
return "No MRs to review"
sender_gitlab_id = None
- for user in self.gitlab.getusers():
- if user['username'] == sender:
- sender_gitlab_id = user['id']
- break
-
- if not sender_gitlab_id:
+ sender_users = self.gitlab.getusers(search=(('username', sender)))
+ if not sender_users:
self.log.error('problem mapping {} to a gitlab user'.format(sender))
- return "Sorry, I couldn't find your gitlab account."
+ sender_gitlab_id = None
+ else:
+ sender_gitlab_id = sender_users[0]['id']
# Walk through the MRs we've seen already:
msg_list = []
msg = ""
still_open_mrs = {}
- with self.mutable('OPEN_MRS') as open_mrs:
- for (project, iid, notify_rooms) in open_mrs:
+ open_mrs = self['OPEN_MRS']
+ for (project, iid, notify_rooms) in open_mrs:
- # Lookup the MR from the project/iid
- a_mr = self.gitlab.getmergerequest(project, iid)
-
- # If the MR is no longer open, skip to the next MR,
- # and don't include this MR in the next check
- if a_mr['state'] != 'opened':
- continue
- else:
- still_open_mrs[(project, iid, notify_rooms)] = True
+ # Lookup the MR from the project/iid
+ a_mr = self.gitlab.getmergerequest(project, iid)
- msg_tuple = self.mr_status_msg(a_mr, author=sender_gitlab_id)
- if msg_tuple is None:
- continue
+ # If the MR is no longer open, skip to the next MR,
+ # and don't include this MR in the next check
+ if 'opened' not in a_mr['state']:
+ continue
+ else:
+ still_open_mrs[(project, iid, notify_rooms)] = True
- msg_list.append(msg_tuple)
+ msg_tuple = self.mr_status_msg(a_mr, author=sender_gitlab_id)
+ if msg_tuple is None:
+ continue
+
+ msg_list.append(msg_tuple)
if msg_list == []:
response = 'Hi {}: {}'.format(sender, 'I found no open MRs for you.')
else:
- sorted_msg_list = sorted(msg_list, key=lambda x: x[0]) # sort by the creation time
- msgs = [x[1] for x in sorted_msg_list] # extract the msgs from the tuple list
- msg = "\n".join(msgs) # join those msgs together.
- response = 'Hi {}: These MRs need some attention:\n{}'.format(sender,msg)
+ # sort by the creation time
+ sorted_msg_list = sorted(msg_list, key=lambda x: x[0])
+
+ # extract the msgs from the tuple list
+ msgs = [x[1] for x in sorted_msg_list]
- with self.mutable('OPEN_MRS') as open_mrs:
- open_mrs = still_open_mrs
+ # join those msgs together.
+ msg = "\n".join(msgs)
+ response = 'Hi {}: These MRs need some attention:\n{}'.format(sender, msg)
+
+ self['OPEN_MRS'] = still_open_mrs
return response
+ # pragma pylint: disable=unused-argument
@botcmd()
def hello(self, msg, args):
+ """
+ A simple command to check if the bot is responding
+ """
return "Hi there"
@botcmd()
def xyzzy(self, msg, args):
- yield "/me whispers \"All open MRs have ben merged into master.\""
+ """
+ Don't call this command...
+ """
+ yield "/me whispers \"All open MRs have been merged into master.\""
sleep(5)
yield "(just kidding)"
+
+ # pragma pylint: enable=unused-argument
--- /dev/null
+errcron
+pyapi-gitlab
+python-dateutil
+errbot
+sleekxmpp
+slackclient
+irc
--- /dev/null
+[aliases]
+test = pytest
+
+[tool:pytest]
+addopts = --cov=plugins --cov-report term-missing --cov-report html --pep8 --pylint --pylint-rcfile=.pylintrc
+pep8ignore =
+ *.py E501
\ No newline at end of file
--- /dev/null
+"""
+Setup.py
+"""
+# pragma pylint: disable=invalid-name
+from setuptools import setup
+
+with open('requirements.txt') as f:
+ install_required = f.read().splitlines()
+
+with open('test-requirements.txt') as f:
+ tests_required = f.read().splitlines()
+
+setup(
+ name='Margebot',
+ version='1.0.0',
+ packages=['plugins', ],
+ license='GPLv3',
+ long_description=open('README.md').read(),
+ url='https://pwan.org/git/?p=margebot.git;a=summary',
+ author='JudeN',
+ author_email='margebot_spam@pwan.org',
+
+ install_requires=install_required,
+
+ setup_requires=['pytest-runner'],
+ tests_require=tests_required,
+)
--- /dev/null
+pytest
+pytest-catchlog
+pytest-cov
+pytest-mock
+pytest-pep8
+pytest-pylint
--- /dev/null
+"""
+Mrgebot tests
+"""
+# pragma pylint: disable=invalid-name
+# pragma pylint: disable=missing-docstring
+# pragma pylint: disable=no-else-return
+# pragma pylint: disable=protected-access
+# pragma pylint: disable=redefined-outer-name
+# pragma pylint: disable=too-many-public-methods
+# pragma pylint: disable=unused-argument
+
+from datetime import datetime
+import logging
+import json
+
+import pytest
+import errbot
+from errbot.backends.test import testbot # pylint: disable=unused-import
+import gitlab
+from dateutil.relativedelta import relativedelta
+from plugins.marge import deltastr
+
+
+class TestMarge(object):
+ """
+ Margebot Tests
+
+ Run 'py.test' from the margebot root directory
+ """
+
+ extra_plugin_dir = "./plugins/"
+ loglevel = logging.INFO
+
+ @pytest.fixture
+ def margebot(self, testbot, monkeypatch, mocker):
+ testbot.push_message("!plugin config Marge {'CHATROOM_HOST': 'conference.test.com', 'GITLAB_HOST': 'gitlab.test.com', 'GITLAB_ADMIN_TOKEN': 'fake-token', 'CRONTAB': '0 * * * *', 'VERIFY_SSL': True, 'CRONTAB_SOAK_HOURS': 1}")
+ testbot.pop_message()
+ testbot.push_message("!plugin config Webserver {'HOST': '0.0.0.0', 'PORT':3141, 'SSL': {'certificate': '', 'enabled': False, 'host': '0.0.0.0', 'key': '', 'port': 3142}}")
+ testbot.pop_message()
+
+ def mock_keys(self):
+ return ['OPEN_MRS']
+ monkeypatch.setattr(errbot.storage.StoreMixin, 'keys', mock_keys, raising=False)
+
+ return testbot
+
+ @pytest.fixture
+ def margebot_no_reviews(self, margebot, monkeypatch):
+
+ def mock_get(self, key):
+ return {}
+
+ monkeypatch.setattr(errbot.storage.StoreMixin, '__getitem__', mock_get, raising=False)
+ return margebot
+
+ @pytest.fixture
+ def margebot_one_review(self, margebot, monkeypatch):
+
+ def mock_get(self, key):
+ return {(1001, 2001, 'room1,room2'): True} # [(project, iid, notify_rooms)]
+
+ monkeypatch.setattr(errbot.storage.StoreMixin, '__getitem__', mock_get, raising=False)
+ return margebot
+
+ @pytest.fixture
+ def one_wip_review(self, margebot_one_review, monkeypatch):
+
+ def mock_getmergerequest(self, project, iid):
+ return {'author': {'id': 2001},
+ 'created_at': 'Oct 29, 2017 2:37am',
+ 'merge_status': 'can_be_merged',
+ 'state': 'opened',
+ 'upvotes': 0,
+ 'web_url': 'http://gitlab.example.com/sample/mr/2001',
+ 'work_in_progress': True}
+ monkeypatch.setattr(gitlab.Gitlab, 'getmergerequest', mock_getmergerequest)
+ return margebot_one_review
+
+ @pytest.fixture
+ def one_waiting_review(self, margebot_one_review, monkeypatch):
+
+ def mock_getmergerequest(self, project, iid):
+ return {'author': {'id': 2001},
+ 'created_at': 'Oct 29, 2017 2:37am',
+ 'merge_status': 'can_be_merged',
+ 'state': 'opened',
+ 'upvotes': 1,
+ 'web_url': 'http://gitlab.example.com/sample/mr/2001',
+ 'work_in_progress': False}
+ monkeypatch.setattr(gitlab.Gitlab, 'getmergerequest', mock_getmergerequest)
+ return margebot_one_review
+
+ @pytest.fixture
+ def one_conflicted_review(self, margebot_one_review, monkeypatch):
+
+ def mock_getmergerequest(self, project, iid):
+ return {'author': {'id': 2001},
+ 'created_at': 'Oct 29, 2017 2:37am',
+ 'merge_status': 'merge_conflicts',
+ 'state': 'opened',
+ 'upvotes': 2,
+ 'web_url': 'http://gitlab.example.com/sample/mr/2001',
+ 'work_in_progress': False}
+ monkeypatch.setattr(gitlab.Gitlab, 'getmergerequest', mock_getmergerequest)
+ return margebot_one_review
+
+ @pytest.fixture
+ def one_mergable_review(self, margebot_one_review, monkeypatch):
+
+ def mock_getmergerequest(self, project, iid):
+ return {'author': {'id': 2001},
+ 'created_at': 'Oct 29, 2017 2:37am',
+ 'merge_status': 'can_be_merged',
+ 'state': 'opened',
+ 'upvotes': 2,
+ 'web_url': 'http://gitlab.example.com/sample/mr/2001',
+ 'work_in_progress': False}
+ monkeypatch.setattr(gitlab.Gitlab, 'getmergerequest', mock_getmergerequest)
+ return margebot_one_review
+
+ @pytest.fixture
+ def gitlab(self, monkeypatch):
+
+ def mock_getuser(self, user):
+ if user == '(missing)':
+ return False
+ else:
+ return {'username': user + ' username'}
+ monkeypatch.setattr(gitlab.Gitlab, 'getuser', mock_getuser)
+
+ def mock_getusers(self, search=None):
+ if search:
+ ((_, val)) = search
+ if val == "(missing)":
+ return []
+ else:
+ return [{'user': val, 'id': 3001}]
+ else:
+ return [{'user': 'user1', 'id': 3001}, {'user': 'user2', 'id': 3002}]
+ monkeypatch.setattr(gitlab.Gitlab, 'getusers', mock_getusers)
+
+ # Waiting on Gitlab 8.9 or greater
+ # def mock_getapprovals(id):
+ # return []
+ # monkeypatch.setattr(gitlab.Gitlab, 'getapprovals', mock_getapprovals)
+
+ return gitlab.Gitlab
+
+ @pytest.fixture
+ def gitlab_no_reviews(self, gitlab, monkeypatch):
+ def mock_getmergerequest(self, project, iid):
+ return {}
+ monkeypatch.setattr(gitlab, 'getuser', mock_getmergerequest)
+
+ @pytest.fixture
+ def gitlab_one_review(self, gitlab, monkeypatch):
+ def mock_getmergerequest(self, project, iid):
+ return {'author': {'id': 2001},
+ 'created_at': 'Oct 29, 2017 2:37am',
+ 'merge_status': 'can_be_merged',
+ 'state': 'opened',
+ 'upvotes': 0,
+ 'web_url': 'http://gitlab.example.com/sample/mr/2001',
+ 'work_in_progress': False}
+ monkeypatch.setattr(gitlab, 'getmergerequest', mock_getmergerequest)
+
+ # ============================================================================
+
+ @pytest.mark.parametrize("rdelta,expected", [
+ (relativedelta(days=1), "1 day ago"),
+ (relativedelta(days=2), "2 days ago"),
+ (relativedelta(days=1, hours=1), "1 day, 1 hour ago"),
+ (relativedelta(days=2, hours=2), "2 days, 2 hours ago"),
+ (relativedelta(hours=2), "2 hours ago"),
+ (relativedelta(days=1, minutes=23), "1 day, 23 minutes ago"),
+ (relativedelta(minutes=2), "2 minutes ago"),
+ (relativedelta(minutes=1), "1 minute ago"),
+ (relativedelta(minutes=0), "now"), ])
+ def test_deltastr(self, rdelta, expected):
+ now = datetime.now()
+ tdelta = (now + rdelta) - now
+ assert deltastr(tdelta) == expected
+
+ def test_help(self, margebot):
+ margebot.push_message('!help')
+ help_message = margebot.pop_message()
+ assert "Marge" in help_message
+ assert '!reviews' in help_message
+ assert '!hello' in help_message
+ assert '!xyzzy' in help_message
+
+ def test_hello(self, margebot):
+ margebot.push_message('!hello')
+ assert 'Hi there' in margebot.pop_message()
+
+# def test_xyzzy(self, margebot):
+# margebot.push_message('!xyzzy')
+# assert 'All open MRs have been merged into master' in margebot.pop_message()
+# time.sleep(6)
+# assert 'just kidding' in margebot.pop_message()
+
+ def test_webstatus(self, margebot):
+ margebot.push_message('!webstatus')
+ assert 'margebot/<rooms>' in margebot.pop_message()
+
+ def test_gitlab_hook(self, margebot, gitlab):
+ request = json.dumps({'object_kind': 'merge_request',
+ 'object_attributes': {
+ 'state': 'opened',
+ 'work_in_progress': '',
+ 'title': 'title',
+ 'author_id': 'author_id',
+ 'target_project_id': 'project_id',
+ 'iid': 'iid'},
+ 'project': {
+ 'homepage': 'url'}})
+ margebot.push_message("!webhook test /margebot/room1,room2 " + request)
+ assert 'New Review: author_id username has opened a new MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+ margebot.push_message('!reviews')
+ assert 'New Review: author_id username has opened a new MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+
+ def test_gitlab_hook_wip(self, margebot, gitlab):
+ request = json.dumps({'object_kind': 'merge_request',
+ 'object_attributes': {
+ 'state': 'opened',
+ 'work_in_progress': 'true',
+ 'title': 'title',
+ 'author_id': 'author_id',
+ 'target_project_id': 'project_id',
+ 'iid': 'iid'},
+ 'project': {
+ 'homepage': 'url'}})
+ margebot.push_message("!webhook test /margebot/room1,room2 " + request)
+ assert 'New Review: author_id username has opened a new WIP MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+ margebot.push_message('!reviews')
+ assert 'New Review: author_id username has opened a new WIP MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+
+ def test_gitlab_hook_unexpected_user(self, margebot, gitlab):
+ request = json.dumps({'object_kind': 'merge_request',
+ 'object_attributes': {
+ 'state': 'opened',
+ 'work_in_progress': '',
+ 'title': 'title',
+ 'author_id': '(missing)',
+ 'target_project_id': 'project_id',
+ 'iid': 'iid'},
+ 'project': {
+ 'homepage': 'url'}})
+
+ margebot.push_message("!webhook test /margebot/room1,room2 " + request)
+ assert 'New Review: (missing) has opened a new MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+ margebot.push_message('!reviews')
+ assert 'New Review: (missing) has opened a new MR: \"title\"\nurl/merge_requests/iid' in margebot.pop_message()
+
+ def test_gitlab_hook_unexpected_object_kind(self, margebot_no_reviews, gitlab, caplog):
+ request = json.dumps({'object_kind': 'not_merge_request',
+ 'object_attributes': {
+ 'state': 'opened',
+ 'work_in_progress': '',
+ 'title': 'title',
+ 'author_id': 'author_id',
+ 'target_project_id': 'project_id',
+ 'iid': 'iid'},
+ 'project': {
+ 'homepage': 'url'}})
+
+ margebot_no_reviews.push_message("!webhook test /margebot/room1,room2 " + request)
+ margebot_no_reviews.pop_message()
+ margebot_no_reviews.push_message('!reviews')
+ assert 'Hi gbin: I found no open MRs for you.' in margebot_no_reviews.pop_message()
+ assert 'unexpecting object_kind: not_merge_request' in caplog.text # Has to be at end of method
+
+ def test_nothing_to_review(self, margebot_no_reviews, gitlab_no_reviews):
+ margebot_no_reviews.push_message('!reviews')
+ assert 'Hi gbin: I found no open MRs for you.' in margebot_no_reviews.pop_message()
+
+ def test_get_one_open_mr(self, margebot_one_review, gitlab_one_review):
+ margebot_one_review.push_message('!reviews')
+ output = margebot_one_review.pop_message()
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001' in output
+ assert 'No upvotes, please review.' in output
+
+ def test_get_one_wip_mr(self, one_wip_review, gitlab):
+ one_wip_review.push_message('!reviews')
+ output = one_wip_review.pop_message()
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001' in output
+ assert 'No upvotes, please review but still WIP.' in output
+
+ def test_get_one_waiting_mr(self, margebot, one_waiting_review, gitlab):
+ one_waiting_review.push_message('!reviews')
+ output = margebot.pop_message()
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001' in output
+ assert 'Waiting for another upvote.' in output
+
+ def test_get_one_mergable_mr(self, margebot, one_mergable_review, gitlab):
+ one_mergable_review.push_message('!reviews')
+ output = margebot.pop_message()
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001' in output
+ assert 'Has 2+ upvotes and could be merged in now.' in output
+
+ def test_get_one_conflicted_mr(self, margebot, one_conflicted_review, gitlab):
+ one_conflicted_review.push_message('!reviews')
+ output = margebot.pop_message(timeout=1)
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001' in output
+ assert 'Has 2+ upvotes and could be merged in now except there are merge conflicts.' in output
+
+ def test_crontab_hook(self, one_waiting_review, gitlab, monkeypatch, mocker):
+ plugin = one_waiting_review._bot.plugin_manager.get_plugin_obj_by_name('Marge')
+
+ def mock_rooms():
+ return [mocker.MagicMock(node='room1'), mocker.MagicMock(node='room2')]
+ monkeypatch.setattr(plugin, 'rooms', mock_rooms)
+
+ plugin.crontab_hook("unused")
+ output = one_waiting_review.pop_message()
+ assert 'These MRs need some attention' in output
+ assert 'http://gitlab.example.com/sample/mr/2001 (opened' in output
projects / margebot.git / commitdiff