Initial commit
mostly as-is, taken from `rattail.fablib` subpackage
This commit is contained in:
Lance Edgar
commit
40dbb595e9
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
*.pyc
|
||||||
|
rattail_fabric.egg-info/
|
||||||
8
CHANGES.rst
Normal file
8
CHANGES.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
|
||||||
|
CHANGELOG
|
||||||
|
=========
|
||||||
|
|
||||||
|
0.1.0 (pending)
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Initial release.
|
||||||
674
COPYING.txt
Normal file
674
COPYING.txt
Normal file
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||||
|
<http://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
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
2
MANIFEST.in
Normal file
2
MANIFEST.in
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
include *.txt
|
||||||
|
include *.rst
|
||||||
14
README.rst
Normal file
14
README.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
|
||||||
|
rattail-fabric
|
||||||
|
==============
|
||||||
|
|
||||||
|
Rattail is a retail software framework, released under the GNU General Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
This package contains various utility functions for use with `Fabric`_.
|
||||||
|
|
||||||
|
.. _`Fabric`: http://www.fabfile.org/
|
||||||
|
|
||||||
|
Please see Rattail's `home page`_ for more information.
|
||||||
|
|
||||||
|
.. _`home page`: https://rattailproject.org/
|
||||||
36
rattail_fabric/__init__.py
Normal file
36
rattail_fabric/__init__.py
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library
|
||||||
|
|
||||||
|
This subpackage contains various tasks and associated functions for use with
|
||||||
|
Fabric deployment and maintenance.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from .core import put, upload_template, make_deploy, mkdir, rsync
|
||||||
|
from .core import make_system_user, set_timezone, agent_sudo
|
||||||
|
from .core import get_debian_version, get_ubuntu_version
|
||||||
|
|
||||||
|
from .python import workon, cdvirtualenv
|
||||||
3
rattail_fabric/_version.py
Normal file
3
rattail_fabric/_version.py
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
|
||||||
|
__version__ = '0.1.0'
|
||||||
142
rattail_fabric/apache.py
Normal file
142
rattail_fabric/apache.py
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for Apache web server
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import re
|
||||||
|
|
||||||
|
from fabric.api import sudo, abort
|
||||||
|
|
||||||
|
from rattail_fabric import apt
|
||||||
|
|
||||||
|
|
||||||
|
def install():
|
||||||
|
"""
|
||||||
|
Install the Apache web service
|
||||||
|
"""
|
||||||
|
apt.install('apache2')
|
||||||
|
|
||||||
|
|
||||||
|
def get_version():
|
||||||
|
"""
|
||||||
|
Fetch the version of Apache running on the target system
|
||||||
|
"""
|
||||||
|
result = sudo('apache2 -v')
|
||||||
|
if result.succeeded:
|
||||||
|
match = re.match(r'^Server version: Apache/(\d+\.\d+)\.\d+ \(.*\)', result)
|
||||||
|
if match:
|
||||||
|
return float(match.group(1))
|
||||||
|
|
||||||
|
|
||||||
|
def install_wsgi(python_home=None, python3=False):
|
||||||
|
"""
|
||||||
|
Install the mod_wsgi Apache module, with optional ``WSGIPythonHome`` value.
|
||||||
|
"""
|
||||||
|
if python3:
|
||||||
|
apt.install('libapache2-mod-wsgi-py3')
|
||||||
|
else:
|
||||||
|
apt.install('libapache2-mod-wsgi')
|
||||||
|
if python_home:
|
||||||
|
if get_version() == 2.2:
|
||||||
|
sudo('echo WSGIPythonHome {} > /etc/apache2/conf.d/wsgi'.format(python_home))
|
||||||
|
else: # assuming 2.4
|
||||||
|
sudo('echo WSGIPythonHome {} > /etc/apache2/conf-available/wsgi.conf'.format(python_home))
|
||||||
|
enable_conf('wsgi')
|
||||||
|
|
||||||
|
|
||||||
|
def enable_conf(*names):
|
||||||
|
"""
|
||||||
|
Enable the given Apache configurations
|
||||||
|
"""
|
||||||
|
for name in names:
|
||||||
|
sudo('a2enconf {}'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def enable_mod(*names):
|
||||||
|
"""
|
||||||
|
Enable the given Apache modules
|
||||||
|
"""
|
||||||
|
for name in names:
|
||||||
|
sudo('a2enmod {}'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def enable_site(*names):
|
||||||
|
"""
|
||||||
|
Enable the given Apache site(s)
|
||||||
|
"""
|
||||||
|
for name in names:
|
||||||
|
sudo('a2ensite {}'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_conf(deployer, local_path, name, enable=False):
|
||||||
|
"""
|
||||||
|
Deploy a config snippet file to Apache
|
||||||
|
"""
|
||||||
|
version = get_version()
|
||||||
|
if version == 2.2:
|
||||||
|
deployer(local_path, '/etc/apache2/conf.d/{}.conf'.format(name))
|
||||||
|
else:
|
||||||
|
deployer(local_path, '/etc/apache2/conf-available/{}.conf'.format(name))
|
||||||
|
if enable:
|
||||||
|
enable_conf(name)
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_site(deployer, local_path, name, enable=False, **kwargs):
|
||||||
|
"""
|
||||||
|
Deploy a file to Apache sites-available
|
||||||
|
"""
|
||||||
|
apache_version = get_version()
|
||||||
|
if apache_version == 2.2:
|
||||||
|
path = '/etc/apache2/sites-available/{}'.format(name)
|
||||||
|
else:
|
||||||
|
path = '/etc/apache2/sites-available/{}.conf'.format(
|
||||||
|
'000-default' if name == 'default' else name)
|
||||||
|
context = kwargs.pop('context', {})
|
||||||
|
context['apache_version'] = apache_version
|
||||||
|
deployer(local_path, path, context=context, **kwargs)
|
||||||
|
if enable and name != 'default':
|
||||||
|
enable_site(name)
|
||||||
|
|
||||||
|
|
||||||
|
def restart():
|
||||||
|
"""
|
||||||
|
Restart the Apache web service
|
||||||
|
"""
|
||||||
|
sudo('service apache2 restart')
|
||||||
|
|
||||||
|
|
||||||
|
def start():
|
||||||
|
"""
|
||||||
|
Start the Apache web service
|
||||||
|
"""
|
||||||
|
sudo('service apache2 start')
|
||||||
|
|
||||||
|
|
||||||
|
def stop():
|
||||||
|
"""
|
||||||
|
Stop the Apache web service
|
||||||
|
"""
|
||||||
|
sudo('service apache2 stop')
|
||||||
114
rattail_fabric/apt.py
Normal file
114
rattail_fabric/apt.py
Normal file
|
|
@ -0,0 +1,114 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for the APT package system
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo, settings
|
||||||
|
from fabric.contrib.files import append
|
||||||
|
|
||||||
|
from rattail_fabric import make_deploy, get_debian_version, get_ubuntu_version
|
||||||
|
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def install(*packages, **kwargs):
|
||||||
|
"""
|
||||||
|
Install one or more packages via ``apt-get install``.
|
||||||
|
"""
|
||||||
|
frontend = kwargs.get('frontend', 'noninteractive')
|
||||||
|
target = kwargs.get('target_release')
|
||||||
|
target = '--target-release={}'.format(target) if target else ''
|
||||||
|
force_yes = ' --force-yes' if kwargs.get('force_yes') else ''
|
||||||
|
sudo('DEBIAN_FRONTEND={} apt-get --assume-yes {}{} install {}'.format(
|
||||||
|
frontend, target, force_yes, ' '.join(packages)))
|
||||||
|
|
||||||
|
|
||||||
|
def purge(*packages):
|
||||||
|
"""
|
||||||
|
Uninstall and purge config for given packages
|
||||||
|
"""
|
||||||
|
sudo('apt-get --assume-yes purge {}'.format(' '.join(packages)))
|
||||||
|
|
||||||
|
|
||||||
|
def update():
|
||||||
|
"""
|
||||||
|
Perform an ``apt-get update`` operation.
|
||||||
|
"""
|
||||||
|
sudo('apt-get update')
|
||||||
|
|
||||||
|
|
||||||
|
def add_repository(repo):
|
||||||
|
"""
|
||||||
|
Add a new APT repository
|
||||||
|
"""
|
||||||
|
sudo('add-apt-repository --yes {}'.format(repo))
|
||||||
|
update()
|
||||||
|
|
||||||
|
|
||||||
|
def add_source(entry):
|
||||||
|
"""
|
||||||
|
Add a new entry to the apt/sources.list file
|
||||||
|
"""
|
||||||
|
append('/etc/apt/sources.list', entry, use_sudo=True)
|
||||||
|
update()
|
||||||
|
|
||||||
|
|
||||||
|
def dist_upgrade(frontend='noninteractive'):
|
||||||
|
"""
|
||||||
|
Perform a full ``apt-get dist-upgrade`` operation.
|
||||||
|
"""
|
||||||
|
update()
|
||||||
|
sudo('DEBIAN_FRONTEND={} apt-get --assume-yes dist-upgrade'.format(frontend))
|
||||||
|
|
||||||
|
|
||||||
|
def configure_listchanges():
|
||||||
|
"""
|
||||||
|
Configure apt listchanges to never use a frontend.
|
||||||
|
"""
|
||||||
|
deploy('apt/listchanges.conf', '/etc/apt/listchanges.conf')
|
||||||
|
|
||||||
|
|
||||||
|
def install_emacs():
|
||||||
|
"""
|
||||||
|
Install the Emacs editor
|
||||||
|
"""
|
||||||
|
with settings(warn_only=True):
|
||||||
|
result = sudo('which emacs')
|
||||||
|
if result.succeeded:
|
||||||
|
return
|
||||||
|
|
||||||
|
emacs = 'emacs-nox'
|
||||||
|
debian_version = get_debian_version()
|
||||||
|
if debian_version:
|
||||||
|
if debian_version < 8:
|
||||||
|
emacs = 'emacs23-nox'
|
||||||
|
else:
|
||||||
|
ubuntu_version = get_ubuntu_version()
|
||||||
|
if ubuntu_version and ubuntu_version < 16:
|
||||||
|
emacs = 'emacs23-nox'
|
||||||
|
|
||||||
|
install(emacs, 'emacs-goodies-el')
|
||||||
74
rattail_fabric/certbot.py
Normal file
74
rattail_fabric/certbot.py
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for Let's Encrypt certbot
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo, cd, abort
|
||||||
|
from fabric.contrib.files import exists
|
||||||
|
|
||||||
|
from rattail_fabric import apt, get_debian_version
|
||||||
|
|
||||||
|
|
||||||
|
def install(source=False):
|
||||||
|
"""
|
||||||
|
Install the Let's Encrypt certbot utility
|
||||||
|
"""
|
||||||
|
if source:
|
||||||
|
if not exists('/usr/local/src/certbot'):
|
||||||
|
with cd('/usr/local/src'):
|
||||||
|
sudo('git clone https://github.com/certbot/certbot')
|
||||||
|
sudo('ln --symbolic --force /usr/local/src/certbot/certbot-auto /usr/local/bin/certbot')
|
||||||
|
|
||||||
|
else:
|
||||||
|
version = get_debian_version()
|
||||||
|
|
||||||
|
# debian 7 wheezy
|
||||||
|
if 7 <= version < 8:
|
||||||
|
if not exists('/usr/local/src/certbot'):
|
||||||
|
with cd('/usr/local/src'):
|
||||||
|
sudo('git clone https://github.com/certbot/certbot')
|
||||||
|
sudo('ln --symbolic --force /usr/local/src/certbot/certbot-auto /usr/local/bin/certbot')
|
||||||
|
|
||||||
|
# debian 8 jessie
|
||||||
|
elif 8 <= version < 9:
|
||||||
|
apt.add_source('deb http://ftp.debian.org/debian jessie-backports main')
|
||||||
|
apt.install('python-certbot-apache', target_release='jessie-backports')
|
||||||
|
|
||||||
|
# debian 9 stretch, or later
|
||||||
|
elif version >= 9:
|
||||||
|
apt.install('python-certbot-apache')
|
||||||
|
|
||||||
|
# other..? will have to investigate when this comes up
|
||||||
|
else:
|
||||||
|
abort("don't know how to install certbot on debian version {}".format(version))
|
||||||
|
|
||||||
|
|
||||||
|
def certonly(*domains):
|
||||||
|
"""
|
||||||
|
Obtain SSL certificates
|
||||||
|
"""
|
||||||
|
domains = ['--domain {}'.format(domain) for domain in domains]
|
||||||
|
sudo('certbot certonly --noninteractive --apache {}'.format(' '.join(domains)))
|
||||||
47
rattail_fabric/composer.py
Normal file
47
rattail_fabric/composer.py
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric lib for Composer (PHP dependency manager)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo
|
||||||
|
from fabric.contrib.files import exists
|
||||||
|
|
||||||
|
from rattail_fabric import make_deploy
|
||||||
|
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def install_composer(user=None):
|
||||||
|
"""
|
||||||
|
Install `composer.phar` in current directory
|
||||||
|
"""
|
||||||
|
if not exists('composer.phar'):
|
||||||
|
deploy('composer/install-composer.sh', 'install-composer.sh')
|
||||||
|
sudo('./install-composer.sh')
|
||||||
|
sudo('rm install-composer.sh')
|
||||||
|
if user:
|
||||||
|
sudo('chown {}: composer.phar'.format(user))
|
||||||
281
rattail_fabric/core.py
Normal file
281
rattail_fabric/core.py
Normal file
|
|
@ -0,0 +1,281 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Core Fabric Library
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import tempfile
|
||||||
|
|
||||||
|
import six
|
||||||
|
|
||||||
|
from fabric.api import sudo, run, cd, local, env, settings, put as fab_put
|
||||||
|
from fabric.contrib.files import exists, append, upload_template as fab_upload_template, is_link
|
||||||
|
|
||||||
|
from mako.template import Template
|
||||||
|
|
||||||
|
|
||||||
|
def get_debian_version():
|
||||||
|
"""
|
||||||
|
Fetch the version of Debian running on the target system.
|
||||||
|
"""
|
||||||
|
version = run('cat /etc/debian_version')
|
||||||
|
match = re.match(r'^(\d+\.\d+)$', version)
|
||||||
|
if match:
|
||||||
|
return float(match.group(1))
|
||||||
|
|
||||||
|
|
||||||
|
def get_ubuntu_version():
|
||||||
|
"""
|
||||||
|
Fetch the version of Ubuntu running on the target system
|
||||||
|
"""
|
||||||
|
info = run('cat /etc/lsb-release')
|
||||||
|
match = re.search(r'DISTRIB_RELEASE=(\d+\.\d+)', info)
|
||||||
|
if match:
|
||||||
|
return float(match.group(1))
|
||||||
|
|
||||||
|
|
||||||
|
def mkdir(paths, owner='root:root', mode=None):
|
||||||
|
"""
|
||||||
|
Recursively make one or more directories.
|
||||||
|
"""
|
||||||
|
if isinstance(paths, six.string_types):
|
||||||
|
paths = [paths]
|
||||||
|
sudo('mkdir --parents {0}'.format(' '.join(paths)))
|
||||||
|
if owner != 'root:root':
|
||||||
|
if ':' not in owner:
|
||||||
|
owner = '{0}:{0}'.format(owner)
|
||||||
|
sudo('chown {} {}'.format(owner, ' '.join(paths)))
|
||||||
|
if mode is not None:
|
||||||
|
sudo('chmod {0} {1}'.format(mode, ' '.join(paths)))
|
||||||
|
|
||||||
|
|
||||||
|
def make_system_user(name='rattail', home='/srv/rattail', uid=None, shell=None):
|
||||||
|
"""
|
||||||
|
Make a new system user account, with the given home folder and shell path.
|
||||||
|
"""
|
||||||
|
with settings(warn_only=True):
|
||||||
|
result = sudo('getent passwd {0}'.format(name))
|
||||||
|
if result.failed:
|
||||||
|
uid = '--uid {0}'.format(uid) if uid else ''
|
||||||
|
shell = '--shell {0}'.format(shell) if shell else ''
|
||||||
|
sudo('adduser --system --home {0} --group {1} {2} {3}'.format(home, name, uid, shell))
|
||||||
|
|
||||||
|
|
||||||
|
def set_timezone(timezone):
|
||||||
|
"""
|
||||||
|
Set the system timezone to the given value, e.g. 'America/Chicago'.
|
||||||
|
"""
|
||||||
|
sudo('echo {} >/etc/timezone'.format(timezone))
|
||||||
|
if is_link('/etc/localtime'):
|
||||||
|
sudo('ln --symbolic --force /usr/share/zoneinfo/{} /etc/localtime'.format(timezone))
|
||||||
|
else:
|
||||||
|
sudo('cp /usr/share/zoneinfo/{} /etc/localtime'.format(timezone))
|
||||||
|
|
||||||
|
|
||||||
|
def agent_sudo(cmd, user=None):
|
||||||
|
"""
|
||||||
|
Run a 'sudo' command on the target server, with full agent forwarding.
|
||||||
|
"""
|
||||||
|
with settings(forward_agent=True):
|
||||||
|
sudo('SSH_AUTH_SOCK=$SSH_AUTH_SOCK {}'.format(cmd), shell=False, user=user)
|
||||||
|
|
||||||
|
|
||||||
|
def put(local_path, remote_path, owner='root:root', **kwargs):
|
||||||
|
"""
|
||||||
|
Put a file on the server, and set its ownership.
|
||||||
|
"""
|
||||||
|
if 'mode' not in kwargs:
|
||||||
|
kwargs.setdefault('mirror_local_mode', True)
|
||||||
|
kwargs['use_sudo'] = True
|
||||||
|
fab_put(local_path, remote_path, **kwargs)
|
||||||
|
sudo('chown {0} {1}'.format(owner, remote_path))
|
||||||
|
|
||||||
|
|
||||||
|
def upload_template(local_path, remote_path, owner='root:root', **kwargs):
|
||||||
|
"""
|
||||||
|
Upload a template to the server, and set its ownership.
|
||||||
|
"""
|
||||||
|
if 'mode' not in kwargs:
|
||||||
|
kwargs.setdefault('mirror_local_mode', True)
|
||||||
|
kwargs['use_sudo'] = True
|
||||||
|
fab_upload_template(local_path, remote_path, **kwargs)
|
||||||
|
sudo('chown {0} {1}'.format(owner, remote_path))
|
||||||
|
|
||||||
|
|
||||||
|
def upload_mako_template(local_path, remote_path, context={}, **kwargs):
|
||||||
|
"""
|
||||||
|
Render a local file as a Mako template, and upload the result to the server.
|
||||||
|
"""
|
||||||
|
template = Template(filename=local_path)
|
||||||
|
|
||||||
|
temp_dir = tempfile.mkdtemp(prefix='rattail-fabric.')
|
||||||
|
temp_path = os.path.join(temp_dir, os.path.basename(local_path))
|
||||||
|
with open(temp_path, 'wb') as f:
|
||||||
|
f.write(template.render(env=env, **context))
|
||||||
|
os.chmod(temp_path, os.stat(local_path).st_mode)
|
||||||
|
|
||||||
|
put(temp_path, remote_path, **kwargs)
|
||||||
|
os.remove(temp_path)
|
||||||
|
os.rmdir(temp_dir)
|
||||||
|
|
||||||
|
|
||||||
|
class Deployer(object):
|
||||||
|
|
||||||
|
def __init__(self, deploy_path, last_segment='deploy'):
|
||||||
|
if not os.path.isdir(deploy_path):
|
||||||
|
deploy_path = os.path.abspath(os.path.join(os.path.dirname(deploy_path), last_segment))
|
||||||
|
self.deploy_path = deploy_path
|
||||||
|
|
||||||
|
def __call__(self, local_path, remote_path, **kwargs):
|
||||||
|
self.deploy(local_path, remote_path, **kwargs)
|
||||||
|
|
||||||
|
def full_path(self, local_path):
|
||||||
|
return '{}/{}'.format(self.deploy_path, local_path)
|
||||||
|
|
||||||
|
def local_exists(self, local_path):
|
||||||
|
return os.path.exists(self.full_path(local_path))
|
||||||
|
|
||||||
|
def deploy(self, local_path, remote_path, **kwargs):
|
||||||
|
local_path = self.full_path(local_path)
|
||||||
|
context = kwargs.pop('context', {})
|
||||||
|
if local_path.endswith('.template'):
|
||||||
|
upload_template(local_path, remote_path, context=env, **kwargs)
|
||||||
|
elif local_path.endswith('.mako'):
|
||||||
|
upload_mako_template(local_path, remote_path, context=context, **kwargs)
|
||||||
|
else:
|
||||||
|
put(local_path, remote_path, **kwargs)
|
||||||
|
|
||||||
|
def sudoers(self, local_path, remote_path, mode='0440', **kwargs):
|
||||||
|
self.deploy(local_path, '/tmp/sudoers', mode=mode)
|
||||||
|
sudo('mv /tmp/sudoers {0}'.format(remote_path))
|
||||||
|
|
||||||
|
def apache_site(self, local_path, name, **kwargs):
|
||||||
|
from rattail_fabric.apache import deploy_site
|
||||||
|
deploy_site(self, local_path, name, **kwargs)
|
||||||
|
|
||||||
|
def apache_conf(self, local_path, name, **kwargs):
|
||||||
|
from rattail_fabric.apache import deploy_conf
|
||||||
|
deploy_conf(self, local_path, name, **kwargs)
|
||||||
|
|
||||||
|
def certbot_account(self, uuid, localdir='certbot/account'):
|
||||||
|
"""
|
||||||
|
Deploy files to establish a certbot account on target server
|
||||||
|
"""
|
||||||
|
localdir = localdir.rstrip('/')
|
||||||
|
paths = [
|
||||||
|
'/etc/letsencrypt/accounts',
|
||||||
|
'/etc/letsencrypt/accounts/acme-v01.api.letsencrypt.org',
|
||||||
|
'/etc/letsencrypt/accounts/acme-v01.api.letsencrypt.org/directory',
|
||||||
|
]
|
||||||
|
final_path = '{}/{}'.format(paths[-1], uuid)
|
||||||
|
paths.append(final_path)
|
||||||
|
if not exists(final_path):
|
||||||
|
mkdir(paths, mode='0700')
|
||||||
|
with cd(final_path):
|
||||||
|
self.deploy('{}/private_key.json'.format(localdir), 'private_key.json', mode='0600')
|
||||||
|
self.deploy('{}/meta.json'.format(localdir), 'meta.json')
|
||||||
|
self.deploy('{}/regr.json'.format(localdir), 'regr.json')
|
||||||
|
|
||||||
|
def luigi_daemon(self, local_path, name=None, register=True, start=True, **kwargs):
|
||||||
|
if name is None:
|
||||||
|
name = local_path.split('/')[-1]
|
||||||
|
self.deploy(local_path, '/etc/init.d/{}'.format(name), **kwargs)
|
||||||
|
if register:
|
||||||
|
sudo('update-rc.d {} defaults'.format(name))
|
||||||
|
if start:
|
||||||
|
sudo('service {} restart'.format(name))
|
||||||
|
|
||||||
|
def soffice_daemon(self, local_path, name=None, register=True, start=True, **kwargs):
|
||||||
|
if name is None:
|
||||||
|
name = local_path.split('/')[-1]
|
||||||
|
self.deploy(local_path, '/etc/init.d/{}'.format(name), **kwargs)
|
||||||
|
if register:
|
||||||
|
sudo('update-rc.d {} defaults'.format(name))
|
||||||
|
if start:
|
||||||
|
sudo('service {} restart'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def make_deploy(deploy_path, last_segment='deploy'):
|
||||||
|
"""
|
||||||
|
Make a ``deploy()`` function, for uploading files to the server.
|
||||||
|
|
||||||
|
During a deployment, one usually needs to upload certain additional files
|
||||||
|
to the server. It's also often necessary to dynamically define certain
|
||||||
|
settings etc. within these files. The :func:`upload_template()` and
|
||||||
|
:func:`put()` functions, respectively, handle uploading files which do and
|
||||||
|
do not require dynamic variable substitution.
|
||||||
|
|
||||||
|
The return value from ``make_deploy()`` is a function which will call
|
||||||
|
``put()`` or ``upload_template()`` based on whether or not the file path
|
||||||
|
ends with ``'.template'``.
|
||||||
|
|
||||||
|
To make the ``deploy()`` function even simpler for the caller, it will
|
||||||
|
assume a certain context for local file paths. This means one only need
|
||||||
|
provide a base file name when calling ``deploy()``, and it will be
|
||||||
|
interpreted as relative to the function's context path.
|
||||||
|
|
||||||
|
The ``deploy_path`` argument is used to establish the context path for the
|
||||||
|
function. If it is a folder path, it will be used as-is; otherwise it will
|
||||||
|
be constructed by joining the parent folder of ``deploy_path`` with the
|
||||||
|
value of ``last_segment``.
|
||||||
|
|
||||||
|
Typical usage then is something like::
|
||||||
|
|
||||||
|
from rattail_fabric import make_deploy
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
deploy('rattail/init-filemon', '/etc/init.d/rattail-filemon',
|
||||||
|
mode='0755')
|
||||||
|
|
||||||
|
deploy('rattail/rattail.conf.template', '/etc/rattail.conf')
|
||||||
|
|
||||||
|
This shows what is intended to be typical, i.e. where ``__file__`` is the
|
||||||
|
only argument required for ``make_deploy()``. For the above to work will
|
||||||
|
require you to have something like this file structure, where
|
||||||
|
``fabfile.py`` is the script which contains the above code::
|
||||||
|
|
||||||
|
myproject/
|
||||||
|
|-- fabfile.py
|
||||||
|
|-- deploy/
|
||||||
|
`-- rattail/
|
||||||
|
|-- init-filemon
|
||||||
|
|-- rattail.conf.template
|
||||||
|
"""
|
||||||
|
return Deployer(deploy_path, last_segment)
|
||||||
|
|
||||||
|
|
||||||
|
def rsync(host, *paths):
|
||||||
|
"""
|
||||||
|
Runs rsync as root, for the given host and file paths.
|
||||||
|
"""
|
||||||
|
for path in paths:
|
||||||
|
assert path.startswith('/')
|
||||||
|
path = path.rstrip('/')
|
||||||
|
# escape path for rsync
|
||||||
|
path = path.replace(' ', r'\\\ ').replace("'", r"\\\'")
|
||||||
|
agent_sudo('rsync -aP --del root@{0}:{1}/ {1}'.format(host, path))
|
||||||
91
rattail_fabric/corepos.py
Normal file
91
rattail_fabric/corepos.py
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for CORE-POS (IS4C)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import webbrowser
|
||||||
|
|
||||||
|
from fabric.api import sudo, cd, env, run
|
||||||
|
from fabric.contrib.files import exists
|
||||||
|
|
||||||
|
from rattail_fabric import apt, mysql, mkdir
|
||||||
|
|
||||||
|
|
||||||
|
def install_fannie(rootdir, branch='version-2.3', first_time=None, url=None):
|
||||||
|
"""
|
||||||
|
Install the Fannie app to the given location
|
||||||
|
"""
|
||||||
|
if first_time is None:
|
||||||
|
first_time = not exists(rootdir)
|
||||||
|
mkdir(rootdir)
|
||||||
|
with cd(rootdir):
|
||||||
|
|
||||||
|
# fannie source
|
||||||
|
if not exists('IS4C'):
|
||||||
|
sudo('git clone https://github.com/CORE-POS/IS4C.git')
|
||||||
|
with cd('IS4C'):
|
||||||
|
sudo('git checkout {}'.format(branch))
|
||||||
|
with cd('IS4C'):
|
||||||
|
sudo('git pull')
|
||||||
|
|
||||||
|
# composer
|
||||||
|
if not exists('composer.phar'):
|
||||||
|
sudo('curl -sS https://getcomposer.org/installer | php')
|
||||||
|
mkdir('/var/www/.composer', owner='www-data')
|
||||||
|
|
||||||
|
# fannie dependencies
|
||||||
|
with cd('IS4C'):
|
||||||
|
mkdir(['vendor', 'fannie/src/javascript/composer-components'], owner='www-data')
|
||||||
|
sudo('../composer.phar install', user='www-data')
|
||||||
|
|
||||||
|
# shadowread
|
||||||
|
with cd('IS4C/fannie/auth/shadowread'):
|
||||||
|
sudo('make')
|
||||||
|
sudo('make install')
|
||||||
|
|
||||||
|
# fannie config
|
||||||
|
with cd('IS4C/fannie'):
|
||||||
|
if not exists('config.php'):
|
||||||
|
sudo('cp config.php.dist config.php')
|
||||||
|
sudo('chown root:www-data config.php')
|
||||||
|
sudo('chmod 0660 config.php')
|
||||||
|
|
||||||
|
# fannie logging
|
||||||
|
with cd('IS4C/fannie/logs'):
|
||||||
|
for name in ['fannie', 'debug_fannie', 'queries', 'php-errors', 'dayend']:
|
||||||
|
sudo('touch {}.log'.format(name))
|
||||||
|
sudo('chown www-data:www-data {}.log'.format(name))
|
||||||
|
|
||||||
|
# fannie databases
|
||||||
|
mysql.create_user('is4c', host='%', password='is4c')
|
||||||
|
mysql.create_db('core_op', user="is4c@'%'")
|
||||||
|
mysql.create_db('core_trans', user="is4c@'%'")
|
||||||
|
mysql.create_db('trans_archive', user="is4c@'%'")
|
||||||
|
|
||||||
|
# fannie web installer
|
||||||
|
if first_time:
|
||||||
|
url = url or getattr(env, 'fannie_rooturl', 'http://localhost/fannie/')
|
||||||
|
webbrowser.open_new_tab('{}/install/'.format(url.rstrip('/')))
|
||||||
6
rattail_fabric/deploy/apt/listchanges.conf
Normal file
6
rattail_fabric/deploy/apt/listchanges.conf
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
[apt]
|
||||||
|
frontend=none
|
||||||
|
email_address=root
|
||||||
|
confirm=0
|
||||||
|
save_seen=/var/lib/apt/listchanges.db
|
||||||
|
which=news
|
||||||
142
rattail_fabric/deploy/bouncer
Normal file
142
rattail_fabric/deploy/bouncer
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
|
||||||
|
# This script is mostly based on the ``/etc/init.d/skeleton`` file from a
|
||||||
|
# Debian 6 system.
|
||||||
|
|
||||||
|
|
||||||
|
DESC=${DESC:-"Rattail Email Bouncer"}
|
||||||
|
NAME=${NAME:-"rattail-bouncer"}
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
|
||||||
|
PYTHON=${PYTHON:-"/usr/bin/python"}
|
||||||
|
RATTAIL=${RATTAIL:-"/usr/local/bin/rattail"}
|
||||||
|
RATTAIL_ARGS=${RATTAIL_ARGS:-""}
|
||||||
|
BOUNCER_ARGS=${BOUNCER_ARGS:-"--pidfile=$PIDFILE"}
|
||||||
|
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
|
||||||
|
|
||||||
|
# Read configuration variable files if present.
|
||||||
|
[ -r /etc/default/rattail ] && . /etc/default/rattail
|
||||||
|
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
|
||||||
|
|
||||||
|
# Load the VERBOSE setting and other rcS variables.
|
||||||
|
. /lib/init/vars.sh
|
||||||
|
|
||||||
|
# Define LSB log_* functions.
|
||||||
|
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
|
||||||
|
# and status_of_proc is working.
|
||||||
|
. /lib/lsb/init-functions
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that starts the daemon/service
|
||||||
|
#
|
||||||
|
do_start()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
create_pid_dir
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --user $USER --test --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --startas $RATTAIL --chuid $USER --group $GROUP --quiet -- \
|
||||||
|
$RATTAIL_ARGS bouncer $BOUNCER_ARGS start \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that stops the daemon/service
|
||||||
|
#
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
sudo -u $USER $RATTAIL $RATTAIL_ARGS bouncer $BOUNCER_ARGS stop > /dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
62
rattail_fabric/deploy/check-rattail-daemon
Executable file
62
rattail_fabric/deploy/check-rattail-daemon
Executable file
|
|
@ -0,0 +1,62 @@
|
||||||
|
#!/bin/sh
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# This is a simple script which will output a single line of info, and exit
|
||||||
|
# with a return code which indicates status of a given Rattail daemon. It was
|
||||||
|
# designed for use with Shinken monitoring. Invoke like so:
|
||||||
|
#
|
||||||
|
# check-rattail-daemon NAME
|
||||||
|
#
|
||||||
|
# Where NAME refers to the service, e.g. 'rattail-datasync'. Exit code may be:
|
||||||
|
#
|
||||||
|
# * 0 = daemon is confirmed running
|
||||||
|
# * 2 = daemon is confirmed *not* running
|
||||||
|
# * 3 = unknown state
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
NAME="$1"
|
||||||
|
if [ "$NAME" = "" ]; then
|
||||||
|
echo "Usage: check-rattail-daemon NAME"
|
||||||
|
exit 3
|
||||||
|
fi
|
||||||
|
|
||||||
|
PIDFILE="/var/run/rattail/$NAME.pid"
|
||||||
|
if [ ! -f "$PIDFILE" ]; then
|
||||||
|
echo "PID file not found: $PIDFILE"
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
|
||||||
|
PID=`cat $PIDFILE`
|
||||||
|
if [ "$PID" = "" ]; then
|
||||||
|
echo "File exists but contains no PID: $PIDFILE"
|
||||||
|
exit 3
|
||||||
|
fi
|
||||||
|
ps -p $PID >/dev/null
|
||||||
|
if [ ! $? ]; then
|
||||||
|
echo "No process found for PID $PID; per file: $PIDFILE"
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Rattail daemon $NAME is running with PID $PID"
|
||||||
|
exit 0
|
||||||
17
rattail_fabric/deploy/composer/install-composer.sh
Executable file
17
rattail_fabric/deploy/composer/install-composer.sh
Executable file
|
|
@ -0,0 +1,17 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
EXPECTED_SIGNATURE=$(wget -q -O - https://composer.github.io/installer.sig)
|
||||||
|
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
|
||||||
|
ACTUAL_SIGNATURE=$(php -r "echo hash_file('SHA384', 'composer-setup.php');")
|
||||||
|
|
||||||
|
if [ "$EXPECTED_SIGNATURE" != "$ACTUAL_SIGNATURE" ]
|
||||||
|
then
|
||||||
|
>&2 echo 'ERROR: Invalid installer signature'
|
||||||
|
rm composer-setup.php
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
php composer-setup.php --quiet
|
||||||
|
RESULT=$?
|
||||||
|
rm composer-setup.php
|
||||||
|
exit $RESULT
|
||||||
148
rattail_fabric/deploy/daemon
Normal file
148
rattail_fabric/deploy/daemon
Normal file
|
|
@ -0,0 +1,148 @@
|
||||||
|
#!/bin/sh
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Generic 'init' script for all Rattail daemons. Originally based on the
|
||||||
|
# skeleton file from a Debian 6 system, but tweaked plenty since...
|
||||||
|
#
|
||||||
|
# NOTE: The "calling" script *must* define $NAME and $DESC (at least).
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
# Files in /etc/default and/or the "calling" init script may define any of the
|
||||||
|
# following as necessary, to override:
|
||||||
|
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
|
||||||
|
PYTHON=${PYTHON:-"/usr/bin/python"}
|
||||||
|
RATTAIL=${RATTAIL:-"/usr/local/bin/rattail"}
|
||||||
|
RATTAIL_ARGS=${RATTAIL_ARGS:-""}
|
||||||
|
RATTAIL_SUBCMD=${RATTAIL_SUBCMD:-"${NAME##*-}"}
|
||||||
|
RATTAIL_SUBCMD_ARGS=${RATTAIL_SUBCMD_ARGS:-""}
|
||||||
|
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
|
||||||
|
|
||||||
|
# Read configuration variable files if present.
|
||||||
|
[ -r /etc/default/rattail ] && . /etc/default/rattail
|
||||||
|
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
|
||||||
|
|
||||||
|
# Load the VERBOSE setting and other rcS variables.
|
||||||
|
. /lib/init/vars.sh
|
||||||
|
|
||||||
|
# Define LSB log_* functions.
|
||||||
|
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
|
||||||
|
# and status_of_proc is working.
|
||||||
|
. /lib/lsb/init-functions
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that starts the daemon/service
|
||||||
|
#
|
||||||
|
do_start()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
create_pid_dir
|
||||||
|
start-stop-daemon --start --pidfile "$PIDFILE" --exec "$PYTHON" --user $USER --test --quiet >/dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --pidfile "$PIDFILE" --exec "$PYTHON" --startas "$RATTAIL" --chuid $USER --group $GROUP --quiet -- \
|
||||||
|
$RATTAIL_ARGS $RATTAIL_SUBCMD --pidfile="$PIDFILE" $RATTAIL_SUBCMD_ARGS start \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that stops the daemon/service
|
||||||
|
#
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
/usr/local/bin/check-rattail-daemon "$NAME" >/dev/null \
|
||||||
|
|| return 1
|
||||||
|
sudo -u $USER "$RATTAIL" $RATTAIL_ARGS $RATTAIL_SUBCMD --pidfile="$PIDFILE" $RATTAIL_SUBCMD_ARGS stop >/dev/null 2>&1 \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
/usr/local/bin/check-rattail-daemon "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
142
rattail_fabric/deploy/datasync
Normal file
142
rattail_fabric/deploy/datasync
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
|
||||||
|
# This script is mostly based on the ``/etc/init.d/skeleton`` file from a
|
||||||
|
# Debian 6 system.
|
||||||
|
|
||||||
|
|
||||||
|
DESC=${DESC:-"Rattail Data Synchronizer"}
|
||||||
|
NAME=${NAME:-"rattail-datasync"}
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
|
||||||
|
PYTHON=${PYTHON:-"/usr/bin/python"}
|
||||||
|
RATTAIL=${RATTAIL:-"/usr/local/bin/rattail"}
|
||||||
|
RATTAIL_ARGS=${RATTAIL_ARGS:-""}
|
||||||
|
DATASYNC_ARGS=${DATASYNC_ARGS:-"--pidfile=$PIDFILE"}
|
||||||
|
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
|
||||||
|
|
||||||
|
# Read configuration variable files if present.
|
||||||
|
[ -r /etc/default/rattail ] && . /etc/default/rattail
|
||||||
|
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
|
||||||
|
|
||||||
|
# Load the VERBOSE setting and other rcS variables.
|
||||||
|
. /lib/init/vars.sh
|
||||||
|
|
||||||
|
# Define LSB log_* functions.
|
||||||
|
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
|
||||||
|
# and status_of_proc is working.
|
||||||
|
. /lib/lsb/init-functions
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that starts the daemon/service
|
||||||
|
#
|
||||||
|
do_start()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
create_pid_dir
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --user $USER --test --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --startas $RATTAIL --chuid $USER --group $GROUP --quiet -- \
|
||||||
|
$RATTAIL_ARGS datasync $DATASYNC_ARGS start \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that stops the daemon/service
|
||||||
|
#
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
sudo -u $USER $RATTAIL $RATTAIL_ARGS datasync $DATASYNC_ARGS stop > /dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
142
rattail_fabric/deploy/filemon
Normal file
142
rattail_fabric/deploy/filemon
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
|
||||||
|
# This script is mostly based on the ``/etc/init.d/skeleton`` file from a
|
||||||
|
# Debian 6 system.
|
||||||
|
|
||||||
|
|
||||||
|
DESC=${DESC:-"Rattail File Monitor"}
|
||||||
|
NAME=${NAME:-"rattail-filemon"}
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
|
||||||
|
PYTHON=${PYTHON:-"/usr/bin/python"}
|
||||||
|
RATTAIL=${RATTAIL:-"/usr/local/bin/rattail"}
|
||||||
|
RATTAIL_ARGS=${RATTAIL_ARGS:-""}
|
||||||
|
FILEMON_ARGS=${FILEMON_ARGS:-"--pidfile=$PIDFILE"}
|
||||||
|
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
|
||||||
|
|
||||||
|
# Read configuration variable files if present.
|
||||||
|
[ -r /etc/default/rattail ] && . /etc/default/rattail
|
||||||
|
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
|
||||||
|
|
||||||
|
# Load the VERBOSE setting and other rcS variables.
|
||||||
|
. /lib/init/vars.sh
|
||||||
|
|
||||||
|
# Define LSB log_* functions.
|
||||||
|
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
|
||||||
|
# and status_of_proc is working.
|
||||||
|
. /lib/lsb/init-functions
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that starts the daemon/service
|
||||||
|
#
|
||||||
|
do_start()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
create_pid_dir
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --user $USER --test --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --pidfile $PIDFILE --exec $PYTHON --startas $RATTAIL --chuid $USER --group $GROUP --quiet -- \
|
||||||
|
$RATTAIL_ARGS filemon $FILEMON_ARGS start \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Function that stops the daemon/service
|
||||||
|
#
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
sudo -u $USER $RATTAIL $RATTAIL_ARGS filemon $FILEMON_ARGS stop > /dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
126
rattail_fabric/deploy/luigid
Normal file
126
rattail_fabric/deploy/luigid
Normal file
|
|
@ -0,0 +1,126 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Generic 'init' script for Luigi central scheduler (luigid)
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
# "calling" init script may define any of the following as necessary:
|
||||||
|
|
||||||
|
NAME=${NAME:-"rattail-luigid"}
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
DESC=${DESC:-"Luigi Scheduler for Rattail"}
|
||||||
|
DAEMON=${DAEMON:-"/usr/local/bin/luigid"}
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
LOGDIR=${LOGDIR:-"/var/log/rattail/$NAME"}
|
||||||
|
STATEFILE=${STATEFILE:-"/var/run/rattail/$NAME.pickle"}
|
||||||
|
ADDRESS=${ADDRESS:-"0.0.0.0"}
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
do_start() {
|
||||||
|
|
||||||
|
create_pid_dir
|
||||||
|
|
||||||
|
start-stop-daemon --test --start --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --chuid $USER --exec $DAEMON --pidfile $PIDFILE --background --quiet -- \
|
||||||
|
--background --pidfile $PIDFILE --logdir $LOGDIR --state-path $STATEFILE --address $ADDRESS \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
start-stop-daemon --test --stop --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --stop --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
/usr/local/bin/check-rattail-daemon "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
4
rattail_fabric/deploy/mysql/debconf.mako
Normal file
4
rattail_fabric/deploy/mysql/debconf.mako
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
mysql-server-5.5 mysql-server/root_password password ${password}
|
||||||
|
mysql-server-5.5 mysql-server/root_password seen true
|
||||||
|
mysql-server-5.5 mysql-server/root_password_again password ${password}
|
||||||
|
mysql-server-5.5 mysql-server/root_password_again seen true
|
||||||
16
rattail_fabric/deploy/mysql/my.cnf.mako
Normal file
16
rattail_fabric/deploy/mysql/my.cnf.mako
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
|
||||||
|
[mysql]
|
||||||
|
user = root
|
||||||
|
password = ${password}
|
||||||
|
|
||||||
|
[mysqladmin]
|
||||||
|
user = root
|
||||||
|
password = ${password}
|
||||||
|
|
||||||
|
[mysqldump]
|
||||||
|
user = root
|
||||||
|
password = ${password}
|
||||||
|
|
||||||
|
[mysqlshow]
|
||||||
|
user = root
|
||||||
|
password = ${password}
|
||||||
5
rattail_fabric/deploy/shinken/commands.cfg
Normal file
5
rattail_fabric/deploy/shinken/commands.cfg
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
|
||||||
|
define command{
|
||||||
|
command_name check_rattail_daemon
|
||||||
|
command_line $PLUGINSDIR$/check_by_ssh -H $HOSTADDRESS$ -C "check-rattail-daemon $ARG1$" --logname=rattail
|
||||||
|
}
|
||||||
5
rattail_fabric/deploy/shinken/rattail.pack
Normal file
5
rattail_fabric/deploy/shinken/rattail.pack
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
{
|
||||||
|
"name": "rattail",
|
||||||
|
"description": "Can check various Rattail daemons to ensure they're running. Performs checks using SSH.",
|
||||||
|
"path": "software/"
|
||||||
|
}
|
||||||
6
rattail_fabric/deploy/shinken/templates.cfg
Normal file
6
rattail_fabric/deploy/shinken/templates.cfg
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
|
||||||
|
define host{
|
||||||
|
name rattail
|
||||||
|
use linux
|
||||||
|
register 0
|
||||||
|
}
|
||||||
125
rattail_fabric/deploy/soffice
Normal file
125
rattail_fabric/deploy/soffice
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Generic 'init' script for headless LibreOffice Writer
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
# "calling" init script may define any of the following as necessary:
|
||||||
|
|
||||||
|
NAME=${NAME:-"rattail-soffice"}
|
||||||
|
SCRIPTNAME=${SCRIPTNAME:-"/etc/init.d/$NAME"}
|
||||||
|
DESC=${DESC:-"LibreOffice for Rattail"}
|
||||||
|
DAEMON=${DAEMON:-"/usr/lib/libreoffice/program/soffice.bin"}
|
||||||
|
SOFFICE=${SOFFICE:-"/usr/bin/soffice"}
|
||||||
|
USER=${USER:-"rattail"}
|
||||||
|
GROUP=${GROUP:-"rattail"}
|
||||||
|
PIDFILE=${PIDFILE:-"/var/run/rattail/$NAME.pid"}
|
||||||
|
PORT=${PORT:-"2002"}
|
||||||
|
|
||||||
|
|
||||||
|
create_pid_dir() {
|
||||||
|
PIDDIR=`dirname "$PIDFILE"`
|
||||||
|
if [ ! -d "$PIDDIR" ]; then
|
||||||
|
mkdir --parents "$PIDDIR"
|
||||||
|
fi
|
||||||
|
chown $USER:$GROUP "$PIDDIR"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been started
|
||||||
|
# 1 if daemon was already running
|
||||||
|
# 2 if daemon could not be started
|
||||||
|
do_start() {
|
||||||
|
|
||||||
|
create_pid_dir
|
||||||
|
|
||||||
|
start-stop-daemon --test --start --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --start --chuid $USER --exec $DAEMON --startas $SOFFICE --pidfile $PIDFILE --background --quiet -- \
|
||||||
|
--headless --pidfile=$PIDFILE --accept="socket,host=localhost,port=$PORT;urp;" \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Return
|
||||||
|
# 0 if daemon has been stopped
|
||||||
|
# 1 if daemon was already stopped
|
||||||
|
# 2 if daemon could not be stopped
|
||||||
|
# other if a failure occurred
|
||||||
|
do_stop()
|
||||||
|
{
|
||||||
|
start-stop-daemon --test --stop --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 1
|
||||||
|
start-stop-daemon --stop --exec $DAEMON --user $USER --pidfile $PIDFILE --quiet > /dev/null \
|
||||||
|
|| return 2
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
start)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
stop)
|
||||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
|
||||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
status)
|
||||||
|
/usr/local/bin/check-rattail-daemon "$NAME" && exit 0 || exit $?
|
||||||
|
;;
|
||||||
|
restart|force-reload)
|
||||||
|
log_daemon_msg "Restarting $DESC" "$NAME"
|
||||||
|
do_stop
|
||||||
|
case "$?" in
|
||||||
|
0|1)
|
||||||
|
do_start
|
||||||
|
case "$?" in
|
||||||
|
0) log_end_msg 0 ;;
|
||||||
|
1) log_end_msg 1 ;; # Old process is still running
|
||||||
|
*) log_end_msg 1 ;; # Failed to start
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
# Failed to stop
|
||||||
|
log_end_msg 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
|
||||||
|
exit 3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
:
|
||||||
4
rattail_fabric/deploy/sudoers
Normal file
4
rattail_fabric/deploy/sudoers
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
# -*- mode: conf; -*-
|
||||||
|
|
||||||
|
# let rattail upgrade itself
|
||||||
|
rattail ALL = NOPASSWD: /srv/envs/*/app/upgrade*.sh *
|
||||||
208
rattail_fabric/mysql.py
Normal file
208
rattail_fabric/mysql.py
Normal file
|
|
@ -0,0 +1,208 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library for MySQL
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo, hide, get, put, abort, local, run, settings
|
||||||
|
from fabric.contrib.files import sed
|
||||||
|
|
||||||
|
from rattail_fabric import apt, make_deploy
|
||||||
|
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def install(password):
|
||||||
|
"""
|
||||||
|
Install the MySQL database service
|
||||||
|
"""
|
||||||
|
deploy('mysql/debconf.mako', 'debconf', context={'password': password})
|
||||||
|
sudo('debconf-set-selections debconf')
|
||||||
|
sudo('rm debconf')
|
||||||
|
apt.install('mysql-server')
|
||||||
|
deploy('mysql/my.cnf.mako', '/root/.my.cnf', mode='0600', context={'password': password})
|
||||||
|
|
||||||
|
|
||||||
|
def is_mariadb():
|
||||||
|
"""
|
||||||
|
Returns boolean indicating if MySQL server is actually MariaDB.
|
||||||
|
"""
|
||||||
|
with settings(warn_only=True):
|
||||||
|
result = run('mysql --version')
|
||||||
|
if result.failed:
|
||||||
|
return False
|
||||||
|
if "MariaDB" in result:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def restart():
|
||||||
|
"""
|
||||||
|
Restart the MySQL database service
|
||||||
|
"""
|
||||||
|
sudo('service mysql restart')
|
||||||
|
|
||||||
|
|
||||||
|
def set_bind_address(address):
|
||||||
|
"""
|
||||||
|
Configure the 'bind-address' setting with the given value.
|
||||||
|
"""
|
||||||
|
sed('/etc/mysql/my.cnf', '^bind-address.*', 'bind-address = {}'.format(address), use_sudo=True)
|
||||||
|
|
||||||
|
|
||||||
|
def user_exists(name, host='localhost'):
|
||||||
|
"""
|
||||||
|
Determine if a given MySQL user exists.
|
||||||
|
"""
|
||||||
|
user = sql("SELECT User FROM user WHERE User = '{0}' and Host = '{1}'".format(name, host), database='mysql')
|
||||||
|
return user == name
|
||||||
|
|
||||||
|
|
||||||
|
def create_user(name, host='localhost', password=None, checkfirst=True):
|
||||||
|
"""
|
||||||
|
Create a MySQL user account.
|
||||||
|
"""
|
||||||
|
if not checkfirst or not user_exists(name, host):
|
||||||
|
sql("CREATE USER '{0}'@'{1}';".format(name, host))
|
||||||
|
if password:
|
||||||
|
with hide('running'):
|
||||||
|
sql("SET PASSWORD FOR '{0}'@'{1}' = PASSWORD('{2}');".format(
|
||||||
|
name, host, password))
|
||||||
|
|
||||||
|
|
||||||
|
def drop_user(name, host='localhost'):
|
||||||
|
"""
|
||||||
|
Drop a MySQL user account.
|
||||||
|
"""
|
||||||
|
sql("drop user '{0}'@'{1}'".format(name, host))
|
||||||
|
|
||||||
|
|
||||||
|
def db_exists(name):
|
||||||
|
"""
|
||||||
|
Determine if a given MySQL database exists.
|
||||||
|
"""
|
||||||
|
db = sql("SELECT SCHEMA_NAME FROM SCHEMATA WHERE SCHEMA_NAME = '{0}'".format(name), database='information_schema')
|
||||||
|
return db == name
|
||||||
|
|
||||||
|
|
||||||
|
def table_exists(name, database):
|
||||||
|
"""
|
||||||
|
Determine if a given table exists within the given MySQL database.
|
||||||
|
"""
|
||||||
|
table = sql("SELECT TABLE_NAME FROM TABLES WHERE TABLE_SCHEMA = '{0}' AND TABLE_NAME = '{1}'".format(database, name), database='information_schema')
|
||||||
|
return table == name
|
||||||
|
|
||||||
|
|
||||||
|
def create_db(name, checkfirst=True, user=None):
|
||||||
|
"""
|
||||||
|
Create a MySQL database.
|
||||||
|
"""
|
||||||
|
if not checkfirst or not db_exists(name):
|
||||||
|
sudo('mysqladmin create {0}'.format(name))
|
||||||
|
if user:
|
||||||
|
grant_access(name, user)
|
||||||
|
|
||||||
|
|
||||||
|
def drop_db(name, checkfirst=True):
|
||||||
|
"""
|
||||||
|
Drop a MySQL database.
|
||||||
|
"""
|
||||||
|
if not checkfirst or db_exists(name):
|
||||||
|
sudo('mysqladmin drop --force {0}'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def grant_access(dbname, username):
|
||||||
|
"""
|
||||||
|
Grant full access to the given database for the given user. Note that the
|
||||||
|
username should be given in MySQL's native format, e.g. 'myuser@localhost'.
|
||||||
|
"""
|
||||||
|
sql('grant all on `{0}`.* to {1}'.format(dbname, username))
|
||||||
|
|
||||||
|
|
||||||
|
def sql(sql, database=''):
|
||||||
|
"""
|
||||||
|
Execute some SQL.
|
||||||
|
"""
|
||||||
|
# some crazy quoting required here, see also
|
||||||
|
# http://stackoverflow.com/a/1250279
|
||||||
|
sql = sql.replace("'", "'\"'\"'")
|
||||||
|
return sudo("mysql --execute='{}' --batch --skip-column-names {}".format(sql, database))
|
||||||
|
|
||||||
|
|
||||||
|
def download_db(name, destination=None):
|
||||||
|
"""
|
||||||
|
Download a database from the "current" server.
|
||||||
|
"""
|
||||||
|
if destination is None:
|
||||||
|
destination = './{0}.sql.gz'.format(name)
|
||||||
|
sudo('mysqldump --result-file={0}.sql {0}'.format(name))
|
||||||
|
sudo('gzip --force {0}.sql'.format(name))
|
||||||
|
get('{0}.sql.gz'.format(name), destination)
|
||||||
|
sudo('rm {0}.sql.gz'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def restore_db(name, source=None, user=None):
|
||||||
|
"""
|
||||||
|
Upload and restore a database to the current server
|
||||||
|
"""
|
||||||
|
if not source:
|
||||||
|
source = '{}.sql.gz'.format(name)
|
||||||
|
put(source, '{}.sql.gz'.format(name))
|
||||||
|
sudo('gunzip --force {}.sql.gz'.format(name))
|
||||||
|
drop_db(name)
|
||||||
|
create_db(name, user=user)
|
||||||
|
sudo('mysql --execute="source {0}.sql" {0}'.format(name))
|
||||||
|
sudo('rm {}.sql'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def clone_db(name, download, user='rattail', force=False):
|
||||||
|
"""
|
||||||
|
Clone a MySQL database from a (presumably live) server
|
||||||
|
|
||||||
|
:param name: Name of the database.
|
||||||
|
|
||||||
|
:param force: Whether the target database should be forcibly dropped, if it
|
||||||
|
exists already.
|
||||||
|
"""
|
||||||
|
if db_exists(name):
|
||||||
|
if force:
|
||||||
|
drop_db(name, checkfirst=False)
|
||||||
|
else:
|
||||||
|
abort("Database '{}' already exists! (pass force=true to override)".format(name))
|
||||||
|
|
||||||
|
create_db(name, checkfirst=False)
|
||||||
|
|
||||||
|
# obtain database dump from live server
|
||||||
|
download('{}.sql.gz'.format(name), user=user)
|
||||||
|
|
||||||
|
# upload database dump to target server
|
||||||
|
put('{}.sql.gz'.format(name))
|
||||||
|
local('rm {}.sql.gz'.format(name))
|
||||||
|
|
||||||
|
# restore database on target server
|
||||||
|
run('gunzip --force {}.sql.gz'.format(name))
|
||||||
|
sudo('mysql {0} < {0}.sql'.format(name))
|
||||||
|
run('rm {}.sql'.format(name))
|
||||||
47
rattail_fabric/pod.py
Normal file
47
rattail_fabric/pod.py
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library for Product Open Data (POD)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo, cd, env
|
||||||
|
from fabric.contrib.files import exists
|
||||||
|
|
||||||
|
from rattail_fabric import apt, mkdir
|
||||||
|
|
||||||
|
|
||||||
|
def install_pod(path='/srv/pod'):
|
||||||
|
"""
|
||||||
|
Install the Product Open Data (POD) files to the given path.
|
||||||
|
"""
|
||||||
|
apt.install('unzip')
|
||||||
|
mkdir(path)
|
||||||
|
with cd(path):
|
||||||
|
if not exists('pod_pictures_gtin.zip'):
|
||||||
|
url = getattr(env, 'setting_pod_download_url',
|
||||||
|
'http://www.product-open-data.com/docs/pod_pictures_gtin_2013.08.29_01.zip')
|
||||||
|
sudo('wget --output-document=pod_pictures_gtin.zip {0}'.format(url))
|
||||||
|
if not exists('pictures/gtin'):
|
||||||
|
sudo('unzip pod_pictures_gtin.zip -d pictures')
|
||||||
97
rattail_fabric/postfix.py
Normal file
97
rattail_fabric/postfix.py
Normal file
|
|
@ -0,0 +1,97 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for Postfix
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo
|
||||||
|
from fabric.contrib.files import sed, append
|
||||||
|
|
||||||
|
|
||||||
|
from rattail_fabric import apt
|
||||||
|
|
||||||
|
|
||||||
|
def install():
|
||||||
|
"""
|
||||||
|
Install the Postfix mail service
|
||||||
|
"""
|
||||||
|
apt.install('postfix')
|
||||||
|
apt.purge('exim4', 'exim4-base', 'exim4-config', 'exim4-daemon-light')
|
||||||
|
|
||||||
|
|
||||||
|
def alias(name, alias_to, path='/etc/aliases'):
|
||||||
|
"""
|
||||||
|
Set a mail alias for Postfix
|
||||||
|
"""
|
||||||
|
# replace setting if already exists; then add in case it didn't
|
||||||
|
entry = '{}: {}'.format(name, alias_to)
|
||||||
|
sed(path, r'^{}: .*$'.format(name), entry, use_sudo=True)
|
||||||
|
append(path, entry, use_sudo=True)
|
||||||
|
sudo('newaliases')
|
||||||
|
|
||||||
|
|
||||||
|
def restart():
|
||||||
|
"""
|
||||||
|
Restart the Postfix mail service
|
||||||
|
"""
|
||||||
|
sudo('service postfix restart')
|
||||||
|
|
||||||
|
|
||||||
|
def set_config(setting, value, path='/etc/postfix/main.cf'):
|
||||||
|
"""
|
||||||
|
Configure the given setting with the given value.
|
||||||
|
"""
|
||||||
|
# replace setting if already exists; then add in case it didn't
|
||||||
|
entry = '{} = {}'.format(setting, value)
|
||||||
|
sed(path, r'^{} = .*$'.format(setting), entry, use_sudo=True)
|
||||||
|
append(path, entry, use_sudo=True)
|
||||||
|
|
||||||
|
|
||||||
|
def set_myhostname(hostname):
|
||||||
|
"""
|
||||||
|
Configure the 'myhostname' setting with the given string.
|
||||||
|
"""
|
||||||
|
set_config('myhostname', hostname)
|
||||||
|
|
||||||
|
|
||||||
|
def set_mydestination(*destinations):
|
||||||
|
"""
|
||||||
|
Configure the 'mydestinations' setting with the given strings.
|
||||||
|
"""
|
||||||
|
set_config('mydestination', ', '.join(destinations))
|
||||||
|
|
||||||
|
|
||||||
|
def set_mynetworks(*networks):
|
||||||
|
"""
|
||||||
|
Configure the 'mynetworks' setting with the given strings.
|
||||||
|
"""
|
||||||
|
set_config('mynetworks', ' '.join(networks))
|
||||||
|
|
||||||
|
|
||||||
|
def set_relayhost(relayhost):
|
||||||
|
"""
|
||||||
|
Configure the 'relayhost' setting with the given string
|
||||||
|
"""
|
||||||
|
set_config('relayhost', relayhost)
|
||||||
190
rattail_fabric/postgresql.py
Normal file
190
rattail_fabric/postgresql.py
Normal file
|
|
@ -0,0 +1,190 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library for PostgreSQL
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
from fabric.api import sudo, run, get, hide, abort, put, local
|
||||||
|
|
||||||
|
from rattail_fabric import apt
|
||||||
|
|
||||||
|
|
||||||
|
def install():
|
||||||
|
"""
|
||||||
|
Install the PostgreSQL database service
|
||||||
|
"""
|
||||||
|
apt.install('postgresql')
|
||||||
|
|
||||||
|
|
||||||
|
def get_version():
|
||||||
|
"""
|
||||||
|
Fetch the version of PostgreSQL running on the target system
|
||||||
|
"""
|
||||||
|
result = sudo('psql --version')
|
||||||
|
if result.succeeded:
|
||||||
|
match = re.match(r'^psql \(PostgreSQL\) (\d+\.\d+)\.\d+', result)
|
||||||
|
if match:
|
||||||
|
return float(match.group(1))
|
||||||
|
|
||||||
|
|
||||||
|
def sql(sql, database='', port=None):
|
||||||
|
"""
|
||||||
|
Execute some SQL as the 'postgres' user.
|
||||||
|
"""
|
||||||
|
cmd = 'sudo -u postgres psql {port} --tuples-only --no-align --command="{sql}" {database}'.format(
|
||||||
|
port='--port={}'.format(port) if port else '',
|
||||||
|
sql=sql, database=database)
|
||||||
|
return sudo(cmd, shell=False)
|
||||||
|
|
||||||
|
|
||||||
|
def script(path, database='', user=None, password=None):
|
||||||
|
"""
|
||||||
|
Execute a SQL script. By default this will run as 'postgres' user, but can
|
||||||
|
use PGPASSWORD authentication if necessary.
|
||||||
|
"""
|
||||||
|
if user and password:
|
||||||
|
with hide('running'):
|
||||||
|
return sudo(" PGPASSWORD='{}' psql --host=localhost --username='{}' --file='{}' {}".format(
|
||||||
|
password, user, path, database))
|
||||||
|
|
||||||
|
else: # run as postgres
|
||||||
|
return sudo("sudo -u postgres psql --file='{}' {}".format(path, database), shell=False)
|
||||||
|
|
||||||
|
|
||||||
|
def user_exists(name, port=None):
|
||||||
|
"""
|
||||||
|
Determine if a given PostgreSQL user exists.
|
||||||
|
"""
|
||||||
|
user = sql("SELECT rolname FROM pg_roles WHERE rolname = '{0}'".format(name), port=port)
|
||||||
|
return bool(user)
|
||||||
|
|
||||||
|
|
||||||
|
def create_user(name, password=None, port=None, checkfirst=True, createdb=False):
|
||||||
|
"""
|
||||||
|
Create a PostgreSQL user account.
|
||||||
|
"""
|
||||||
|
if not checkfirst or not user_exists(name, port=port):
|
||||||
|
sudo('sudo -u postgres createuser {port} {createdb} --no-createrole --no-superuser {name}'.format(
|
||||||
|
port='--port={}'.format(port) if port else '',
|
||||||
|
createdb='--{}createdb'.format('' if createdb else 'no-'),
|
||||||
|
name=name))
|
||||||
|
if password:
|
||||||
|
set_user_password(name, password, port=port)
|
||||||
|
|
||||||
|
|
||||||
|
def set_user_password(name, password, port=None):
|
||||||
|
"""
|
||||||
|
Set the password for a PostgreSQL user account
|
||||||
|
"""
|
||||||
|
with hide('running'):
|
||||||
|
sql("ALTER USER \\\"{}\\\" PASSWORD '{}';".format(name, password), port=port)
|
||||||
|
|
||||||
|
|
||||||
|
def db_exists(name, port=None):
|
||||||
|
"""
|
||||||
|
Determine if a given PostgreSQL database exists.
|
||||||
|
"""
|
||||||
|
db = sql("SELECT datname FROM pg_database WHERE datname = '{0}'".format(name), port=port)
|
||||||
|
return db == name
|
||||||
|
|
||||||
|
|
||||||
|
def create_db(name, owner=None, port=None, checkfirst=True):
|
||||||
|
"""
|
||||||
|
Create a PostgreSQL database.
|
||||||
|
"""
|
||||||
|
if not checkfirst or not db_exists(name, port=port):
|
||||||
|
cmd = 'sudo -u postgres createdb {port} {owner} {name}'.format(
|
||||||
|
port='--port={}'.format(port) if port else '',
|
||||||
|
owner='--owner={}'.format(owner) if owner else '',
|
||||||
|
name=name)
|
||||||
|
sudo(cmd, shell=False)
|
||||||
|
|
||||||
|
|
||||||
|
def create_schema(name, dbname, owner='rattail', port=None):
|
||||||
|
"""
|
||||||
|
Create a schema within a PostgreSQL database.
|
||||||
|
"""
|
||||||
|
sql_ = "create schema if not exists {} authorization {}".format(name, owner)
|
||||||
|
sql(sql_, database=dbname, port=port)
|
||||||
|
|
||||||
|
|
||||||
|
def drop_db(name, checkfirst=True):
|
||||||
|
"""
|
||||||
|
Drop a PostgreSQL database.
|
||||||
|
"""
|
||||||
|
if not checkfirst or db_exists(name):
|
||||||
|
sudo('sudo -u postgres dropdb {0}'.format(name), shell=False)
|
||||||
|
|
||||||
|
|
||||||
|
def download_db(name, destination=None):
|
||||||
|
"""
|
||||||
|
Download a database from the "current" server.
|
||||||
|
"""
|
||||||
|
if destination is None:
|
||||||
|
destination = './{0}.sql.gz'.format(name)
|
||||||
|
run('touch {0}.sql'.format(name))
|
||||||
|
run('chmod 0666 {0}.sql'.format(name))
|
||||||
|
sudo('sudo -u postgres pg_dump --file={0}.sql {0}'.format(name), shell=False)
|
||||||
|
run('gzip --force {0}.sql'.format(name))
|
||||||
|
get('{0}.sql.gz'.format(name), destination)
|
||||||
|
run('rm {0}.sql.gz'.format(name))
|
||||||
|
|
||||||
|
|
||||||
|
def clone_db(name, owner, download, user='rattail', force=False, workdir=None):
|
||||||
|
"""
|
||||||
|
Clone a database from a (presumably live) server
|
||||||
|
|
||||||
|
:param name: Name of the database.
|
||||||
|
|
||||||
|
:param owner: Username of the user who is to own the database.
|
||||||
|
|
||||||
|
:param force: Whether the target database should be forcibly dropped, if it
|
||||||
|
exists already.
|
||||||
|
"""
|
||||||
|
if db_exists(name):
|
||||||
|
if force:
|
||||||
|
drop_db(name, checkfirst=False)
|
||||||
|
else:
|
||||||
|
abort("Database '{}' already exists!".format(name))
|
||||||
|
|
||||||
|
create_db(name, owner=owner, checkfirst=False)
|
||||||
|
|
||||||
|
# upload database dump to target server
|
||||||
|
if workdir:
|
||||||
|
curdir = os.getcwd()
|
||||||
|
os.chdir(workdir)
|
||||||
|
download('{}.sql.gz'.format(name), user=user)
|
||||||
|
put('{}.sql.gz'.format(name))
|
||||||
|
local('rm {}.sql.gz'.format(name))
|
||||||
|
if workdir:
|
||||||
|
os.chdir(curdir)
|
||||||
|
|
||||||
|
# restore database on target server
|
||||||
|
run('gunzip --force {}.sql.gz'.format(name))
|
||||||
|
sudo('sudo -u postgres psql --file={0}.sql {0}'.format(name), shell=False)
|
||||||
|
run('rm {}.sql'.format(name))
|
||||||
139
rattail_fabric/python.py
Normal file
139
rattail_fabric/python.py
Normal file
|
|
@ -0,0 +1,139 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library for Python
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from contextlib import contextmanager
|
||||||
|
|
||||||
|
import six
|
||||||
|
|
||||||
|
from fabric.api import sudo, run, prefix, cd, settings, env
|
||||||
|
from fabric.contrib.files import exists, append
|
||||||
|
|
||||||
|
from rattail_fabric import apt, mkdir
|
||||||
|
|
||||||
|
|
||||||
|
def install_pip(use_apt=False):
|
||||||
|
"""
|
||||||
|
Install/upgrade the Pip installer for Python.
|
||||||
|
"""
|
||||||
|
if use_apt:
|
||||||
|
apt.install('python-pip')
|
||||||
|
else:
|
||||||
|
apt.install('build-essential', 'python-dev', 'libssl-dev', 'libffi-dev')
|
||||||
|
with settings(warn_only=True):
|
||||||
|
result = sudo('which pip')
|
||||||
|
if result.failed:
|
||||||
|
apt.install('python-pkg-resources', 'python-setuptools')
|
||||||
|
sudo('easy_install pip')
|
||||||
|
sudo('apt-get --assume-yes purge python-setuptools')
|
||||||
|
pip('setuptools')
|
||||||
|
pip('pip', 'wheel', 'ndg-httpsclient')
|
||||||
|
|
||||||
|
|
||||||
|
def pip(*packages):
|
||||||
|
"""
|
||||||
|
Install one or more packages via ``pip install``.
|
||||||
|
"""
|
||||||
|
packages = ["'{0}'".format(p) for p in packages]
|
||||||
|
sudo('pip install --upgrade {0}'.format(' '.join(packages)))
|
||||||
|
|
||||||
|
|
||||||
|
def install_virtualenvwrapper(workon_home=None, user='root', use_apt=False):
|
||||||
|
"""
|
||||||
|
Install the `virtualenvwrapper`_ system, with the given ``workon`` home,
|
||||||
|
owned by the given user.
|
||||||
|
"""
|
||||||
|
workon_home = workon_home or getattr(env, 'python_workon_home', '/srv/envs')
|
||||||
|
mkdir(workon_home, owner=user)
|
||||||
|
if use_apt:
|
||||||
|
apt.install('virtualenvwrapper')
|
||||||
|
else:
|
||||||
|
pip('virtualenvwrapper')
|
||||||
|
configure_virtualenvwrapper('root', workon_home)
|
||||||
|
if user != 'root':
|
||||||
|
configure_virtualenvwrapper(user, workon_home)
|
||||||
|
configure_virtualenvwrapper(env.user, workon_home)
|
||||||
|
|
||||||
|
|
||||||
|
def configure_virtualenvwrapper(user, workon_home=None, wrapper='/usr/local/bin/virtualenvwrapper.sh'):
|
||||||
|
"""
|
||||||
|
Configure virtualenvwrapper for the given user account.
|
||||||
|
"""
|
||||||
|
workon_home = workon_home or getattr(env, 'python_workon_home', '/srv/envs')
|
||||||
|
home = sudo('echo $HOME', user=user)
|
||||||
|
home = home.rstrip('/')
|
||||||
|
|
||||||
|
def update(script):
|
||||||
|
script = '{}/{}'.format(home, script)
|
||||||
|
if not exists(script):
|
||||||
|
sudo('touch {}'.format(script))
|
||||||
|
sudo('chown {}: {}'.format(user, script))
|
||||||
|
append(script, 'export WORKON_HOME={}'.format(workon_home), use_sudo=True)
|
||||||
|
append(script, 'source {}'.format(wrapper), use_sudo=True)
|
||||||
|
|
||||||
|
update('.profile')
|
||||||
|
update('.bashrc')
|
||||||
|
|
||||||
|
|
||||||
|
def mkvirtualenv(name, python=None, user=None, workon_home=None, upgrade_pip=True):
|
||||||
|
"""
|
||||||
|
Make a new Python virtual environment.
|
||||||
|
"""
|
||||||
|
workon_home = workon_home or getattr(env, 'python_workon_home', '/srv/envs')
|
||||||
|
sudo('mkvirtualenv {} {}'.format('--python={}'.format(python) if python else '', name))
|
||||||
|
if upgrade_pip:
|
||||||
|
with workon(name):
|
||||||
|
pip('six')
|
||||||
|
pip('pip', 'setuptools', 'wheel', 'ndg-httpsclient')
|
||||||
|
if user:
|
||||||
|
with cdvirtualenv(name, workon_home=workon_home):
|
||||||
|
mkdir('app/log', owner='{0}:{0}'.format(user))
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def workon(name):
|
||||||
|
"""
|
||||||
|
Context manager to prefix your command(s) with the ``workon`` command.
|
||||||
|
"""
|
||||||
|
with prefix('workon {0}'.format(name)):
|
||||||
|
yield
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def cdvirtualenv(name, subdirs=[], workon_home=None):
|
||||||
|
"""
|
||||||
|
Context manager to prefix your command(s) with the ``cdvirtualenv`` command.
|
||||||
|
"""
|
||||||
|
workon_home = workon_home or getattr(env, 'python_workon_home', '/srv/envs')
|
||||||
|
if isinstance(subdirs, six.string_types):
|
||||||
|
subdirs = [subdirs]
|
||||||
|
path = '{0}/{1}'.format(workon_home, name)
|
||||||
|
if subdirs:
|
||||||
|
path = '{0}/{1}'.format(path, '/'.join(subdirs))
|
||||||
|
with workon(name):
|
||||||
|
with cd(path):
|
||||||
|
yield
|
||||||
79
rattail_fabric/rattail.py
Normal file
79
rattail_fabric/rattail.py
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for Rattail itself
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import sudo, env, cd
|
||||||
|
|
||||||
|
from rattail_fabric import make_deploy, make_system_user, mkdir
|
||||||
|
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def bootstrap_rattail(home='/var/lib/rattail', uid=None, shell='/bin/bash'):
|
||||||
|
"""
|
||||||
|
Bootstrap a basic Rattail software environment.
|
||||||
|
"""
|
||||||
|
make_system_user('rattail', home=home, uid=uid, shell=shell)
|
||||||
|
sudo('adduser {} rattail'.format(env.user))
|
||||||
|
with cd(home):
|
||||||
|
mkdir('.ssh', owner='rattail:', mode='0700')
|
||||||
|
|
||||||
|
mkdir('/etc/rattail')
|
||||||
|
mkdir('/srv/rattail')
|
||||||
|
mkdir('/var/log/rattail', owner='rattail:rattail', mode='0775')
|
||||||
|
|
||||||
|
mkdir('/srv/rattail/init')
|
||||||
|
deploy('daemon', '/srv/rattail/init/daemon')
|
||||||
|
deploy('check-rattail-daemon', '/usr/local/bin/check-rattail-daemon')
|
||||||
|
deploy('luigid', '/srv/rattail/init/luigid')
|
||||||
|
deploy('soffice', '/srv/rattail/init/soffice')
|
||||||
|
# TODO: deprecate / remove these
|
||||||
|
deploy('bouncer', '/srv/rattail/init/bouncer')
|
||||||
|
deploy('datasync', '/srv/rattail/init/datasync')
|
||||||
|
deploy('filemon', '/srv/rattail/init/filemon')
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade_rattail_db(envname=None, envpath=None, config=None, user='rattail'):
|
||||||
|
"""
|
||||||
|
Upgrade a Rattail database in the "default" supported way
|
||||||
|
"""
|
||||||
|
if not (envname or envpath):
|
||||||
|
raise ValueError("Must specify value for either 'envname' or 'envpath'")
|
||||||
|
if not envpath:
|
||||||
|
envpath = '/srv/envs/{}'.format(envname)
|
||||||
|
if not config:
|
||||||
|
config = 'app/rattail.conf'
|
||||||
|
with cd(envpath):
|
||||||
|
sudo('bin/alembic --config {} upgrade heads'.format(config), user=user)
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_rattail_sudoers(remote_path='/etc/sudoers.d/rattail'):
|
||||||
|
"""
|
||||||
|
Deploy the common sudoers file for rattail.
|
||||||
|
"""
|
||||||
|
deploy.sudoers('sudoers', remote_path)
|
||||||
73
rattail_fabric/shinken.py
Normal file
73
rattail_fabric/shinken.py
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric tools for Shinken
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from fabric.api import cd, hide, sudo
|
||||||
|
from fabric.contrib.files import sed
|
||||||
|
|
||||||
|
from rattail_fabric import apt, make_deploy, mkdir
|
||||||
|
|
||||||
|
|
||||||
|
deploy = make_deploy(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def install():
|
||||||
|
"""
|
||||||
|
Install the Shinken monitoring service
|
||||||
|
"""
|
||||||
|
apt.install('shinken')
|
||||||
|
|
||||||
|
|
||||||
|
def restart():
|
||||||
|
"""
|
||||||
|
Restart the Shinken monitoring service
|
||||||
|
"""
|
||||||
|
sudo('service shinken restart')
|
||||||
|
|
||||||
|
|
||||||
|
def install_rattail_pack(dest='/etc/shinken/packs'):
|
||||||
|
"""
|
||||||
|
Install the 'rattail' pack for use with a Shinken system.
|
||||||
|
"""
|
||||||
|
with cd(dest):
|
||||||
|
mkdir('software/rattail')
|
||||||
|
deploy('shinken/rattail.pack', 'software/rattail/rattail.pack')
|
||||||
|
deploy('shinken/templates.cfg', 'software/rattail/templates.cfg')
|
||||||
|
deploy('shinken/commands.cfg', 'software/rattail/commands.cfg')
|
||||||
|
# mkdir('software/rattail/services')
|
||||||
|
# deploy('shinken/services/datasync.cfg', 'software/rattail/services/datasync.cfg')
|
||||||
|
|
||||||
|
# TODO: deprecate / remove this
|
||||||
|
install_shinken_pack = install_rattail_pack
|
||||||
|
|
||||||
|
|
||||||
|
def set_auth_secret(value, path='/etc/shinken/modules/webui.cfg'):
|
||||||
|
"""
|
||||||
|
Set the 'auth_secret' config value for Shinken
|
||||||
|
"""
|
||||||
|
with hide('running'):
|
||||||
|
sed(path, r'^ *auth_secret .*$', ' auth_secret {}'.format(value), use_sudo=True)
|
||||||
37
rattail_fabric/soffice.py
Normal file
37
rattail_fabric/soffice.py
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric library for LibreOffice (etc.)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
from rattail_fabric import apt
|
||||||
|
|
||||||
|
|
||||||
|
def install_headless_writer():
|
||||||
|
"""
|
||||||
|
Install packages for headless LibreOffice Writer
|
||||||
|
"""
|
||||||
|
apt.install('openjdk-8-jdk', 'libreoffice-common',
|
||||||
|
'libreoffice-writer', 'libreoffice-calc')
|
||||||
107
rattail_fabric/ssh.py
Normal file
107
rattail_fabric/ssh.py
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Fabric Library for SSH
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import warnings
|
||||||
|
|
||||||
|
from fabric.api import sudo, cd, settings
|
||||||
|
from fabric.contrib.files import exists, sed, append
|
||||||
|
|
||||||
|
from rattail_fabric import mkdir, agent_sudo
|
||||||
|
from rattail_fabric.python import cdvirtualenv
|
||||||
|
|
||||||
|
|
||||||
|
def cache_host_key(host, for_user='root', with_agent=False, warn_only=True, identity=''):
|
||||||
|
"""
|
||||||
|
Cache the SSH host key for the given host, for the given user.
|
||||||
|
"""
|
||||||
|
user = None if for_user == 'root' else for_user
|
||||||
|
_sudo = agent_sudo if with_agent else sudo
|
||||||
|
if identity:
|
||||||
|
identity = '-i {}'.format(identity)
|
||||||
|
cmd = 'ssh {} -o StrictHostKeyChecking=no {} echo'.format(identity, host)
|
||||||
|
if warn_only:
|
||||||
|
with settings(warn_only=True):
|
||||||
|
_sudo(cmd, user=user)
|
||||||
|
else:
|
||||||
|
_sudo(cmd, user=user)
|
||||||
|
|
||||||
|
|
||||||
|
def uncache_host_key(host, for_user='root'):
|
||||||
|
"""
|
||||||
|
Remove the cached SSH host key for the given host, for the given user.
|
||||||
|
"""
|
||||||
|
user = None if for_user == 'root' else for_user
|
||||||
|
sudo('ssh-keygen -R {}'.format(host), user=user)
|
||||||
|
|
||||||
|
|
||||||
|
def restart():
|
||||||
|
"""
|
||||||
|
Restart the OpenSSH service
|
||||||
|
"""
|
||||||
|
sudo('service ssh restart')
|
||||||
|
|
||||||
|
|
||||||
|
def configure(allow_root=False):
|
||||||
|
"""
|
||||||
|
Configure the OpenSSH service
|
||||||
|
"""
|
||||||
|
path = '/etc/ssh/sshd_config'
|
||||||
|
value = 'without-password' if allow_root else 'no'
|
||||||
|
sed(path, r'^PermitRootLogin\s+.*', 'PermitRootLogin {}'.format(value), use_sudo=True)
|
||||||
|
entry = 'PasswordAuthentication no'
|
||||||
|
sed(path, r'^PasswordAuthentication\s+.*', entry, use_sudo=True)
|
||||||
|
append(path, entry, use_sudo=True)
|
||||||
|
restart()
|
||||||
|
|
||||||
|
|
||||||
|
def configure_ssh(restrict_root=True):
|
||||||
|
warnings.warn("Function `ssh.configure_ssh()` is deprecated, please "
|
||||||
|
"use `ssh.configure()` instead.", DeprecationWarning)
|
||||||
|
return configure(allow_root=not restrict_root)
|
||||||
|
|
||||||
|
|
||||||
|
def establish_identity(envname, comment, user='rattail', home='/var/lib/rattail'):
|
||||||
|
"""
|
||||||
|
Generate a SSH key pair and configure it for local use.
|
||||||
|
"""
|
||||||
|
home = home.rstrip('/')
|
||||||
|
sshdir = '{0}/.ssh'.format(home)
|
||||||
|
owner='{0}:{0}'.format(user)
|
||||||
|
mkdir(sshdir, owner=owner, mode='0700')
|
||||||
|
with cd(sshdir):
|
||||||
|
if not exists('authorized_keys'):
|
||||||
|
sudo('touch authorized_keys')
|
||||||
|
sudo('chown {0} authorized_keys'.format(owner))
|
||||||
|
sudo('chmod 0600 authorized_keys')
|
||||||
|
with cdvirtualenv(envname, 'app'):
|
||||||
|
mkdir('ssh', owner=owner, mode='0700')
|
||||||
|
with cdvirtualenv(envname, 'app/ssh'):
|
||||||
|
if not exists('id_rsa', use_sudo=True):
|
||||||
|
sudo("ssh-keygen -C '{0}' -P '' -f id_rsa".format(comment))
|
||||||
|
sudo('cat id_rsa.pub >> {0}/authorized_keys'.format(sshdir))
|
||||||
|
sudo('chown {0} id_rsa*'.format(owner))
|
||||||
96
setup.py
Normal file
96
setup.py
Normal file
|
|
@ -0,0 +1,96 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import os
|
||||||
|
from setuptools import setup, find_packages
|
||||||
|
|
||||||
|
|
||||||
|
here = os.path.abspath(os.path.dirname(__file__))
|
||||||
|
exec(open(os.path.join(here, 'rattail_fabric', '_version.py')).read())
|
||||||
|
README = open(os.path.join(here, 'README.rst')).read()
|
||||||
|
|
||||||
|
|
||||||
|
requires = [
|
||||||
|
#
|
||||||
|
# Version numbers within comments below have specific meanings.
|
||||||
|
# Basically the 'low' value is a "soft low," and 'high' a "soft high."
|
||||||
|
# In other words:
|
||||||
|
#
|
||||||
|
# If either a 'low' or 'high' value exists, the primary point to be
|
||||||
|
# made about the value is that it represents the most current (stable)
|
||||||
|
# version available for the package (assuming typical public access
|
||||||
|
# methods) whenever this project was started and/or documented.
|
||||||
|
# Therefore:
|
||||||
|
#
|
||||||
|
# If a 'low' version is present, you should know that attempts to use
|
||||||
|
# versions of the package significantly older than the 'low' version
|
||||||
|
# may not yield happy results. (A "hard" high limit may or may not be
|
||||||
|
# indicated by a true version requirement.)
|
||||||
|
#
|
||||||
|
# Similarly, if a 'high' version is present, and especially if this
|
||||||
|
# project has laid dormant for a while, you may need to refactor a bit
|
||||||
|
# when attempting to support a more recent version of the package. (A
|
||||||
|
# "hard" low limit should be indicated by a true version requirement
|
||||||
|
# when a 'high' version is present.)
|
||||||
|
#
|
||||||
|
# In any case, developers and other users are encouraged to play
|
||||||
|
# outside the lines with regard to these soft limits. If bugs are
|
||||||
|
# encountered then they should be filed as such.
|
||||||
|
#
|
||||||
|
# package # low high
|
||||||
|
|
||||||
|
'Fabric', # 1.14.0
|
||||||
|
'invoke', # 0.22.1
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
setup(
|
||||||
|
name = "rattail-fabric",
|
||||||
|
version = __version__,
|
||||||
|
author = "Lance Edgar",
|
||||||
|
author_email = "lance@edbob.org",
|
||||||
|
url = "https://rattailproject.org/",
|
||||||
|
license = "GNU GPL v3",
|
||||||
|
description = "Fabric Utilities for Rattail",
|
||||||
|
long_description = README,
|
||||||
|
|
||||||
|
classifiers = [
|
||||||
|
'Development Status :: 4 - Beta',
|
||||||
|
'Environment :: Console',
|
||||||
|
'Intended Audience :: Developers',
|
||||||
|
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
|
||||||
|
'Natural Language :: English',
|
||||||
|
'Operating System :: OS Independent',
|
||||||
|
'Programming Language :: Python',
|
||||||
|
'Programming Language :: Python :: 2.7',
|
||||||
|
'Topic :: System :: Systems Administration',
|
||||||
|
'Topic :: Software Development :: Libraries :: Python Modules',
|
||||||
|
],
|
||||||
|
|
||||||
|
install_requires = requires,
|
||||||
|
packages = find_packages(),
|
||||||
|
include_package_data = True,
|
||||||
|
zip_safe = False,
|
||||||
|
)
|
||||||
40
tasks.py
Normal file
40
tasks.py
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
# -*- coding: utf-8; -*-
|
||||||
|
################################################################################
|
||||||
|
#
|
||||||
|
# Rattail -- Retail Software Framework
|
||||||
|
# Copyright © 2010-2018 Lance Edgar
|
||||||
|
#
|
||||||
|
# This file is part of Rattail.
|
||||||
|
#
|
||||||
|
# Rattail 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.
|
||||||
|
#
|
||||||
|
# Rattail 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
|
||||||
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
################################################################################
|
||||||
|
"""
|
||||||
|
Tasks for rattail-fabric
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import unicode_literals, absolute_import
|
||||||
|
|
||||||
|
import shutil
|
||||||
|
|
||||||
|
from invoke import task
|
||||||
|
|
||||||
|
|
||||||
|
@task
|
||||||
|
def release(ctx):
|
||||||
|
"""
|
||||||
|
Release a new version of 'rattail-fabric'.
|
||||||
|
"""
|
||||||
|
shutil.rmtree('rattail_fabric.egg-info')
|
||||||
|
ctx.run('python setup.py sdist --formats=gztar upload')
|
||||||
Loading…
Reference in a new issue