Project

General

Profile

« Previous | Next » 

Revision 5ac7ec33

Added by koszko over 1 year ago

  • ID 5ac7ec33fe4b90110faaab3fb178afa9e6de812c
  • Child 34072d8d

initial commit

View differences:

.gitignore
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
build
8
dist
9
*.egg-info
10
*.pyc
11
setuptools
12
src/hydrilla_builder/_version.py
.gitmodules
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
[submodule "src/hydrilla_builder/schemas"]
8
	path = src/hydrilla_builder/schemas
9
	url = ../hydrilla-json-schemas
10
[submodule "src/test/source-package-example"]
11
	path = src/test/source-package-example
12
	url = ../hydrilla-source-package-example
.reuse/dep5
1
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2
Upstream-Name: Hydrilla builder
3
Upstream-Contact: Wojtek Kosior <koszko@koszko.org>
4
Source: https://git.koszko.org/hydrilla-builder
5

  
6
# Sample paragraph, commented out:
7
#
8
# Files: src/*
9
# Copyright: $YEAR $NAME <$CONTACT>
10
# License: ...
LICENSES/AGPL-3.0-or-later.txt
1
GNU AFFERO GENERAL PUBLIC LICENSE
2
Version 3, 19 November 2007
3

  
4
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5

  
6
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
7

  
8
                            Preamble
9

  
10
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
11

  
12
The licenses for most software and other practical works are designed to take away your freedom to share and change the works.  By contrast, our General Public Licenses are 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.
13

  
14
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.
15

  
16
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
17

  
18
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate.  Many developers of free software are heartened and encouraged by the resulting cooperation.  However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
19

  
20
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community.  It requires the operator of a network server to provide the source code of the modified version running there to the users of that server.  Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
21

  
22
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals.  This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
23

  
24
The precise terms and conditions for copying, distribution and modification follow.
25

  
26
                       TERMS AND CONDITIONS
27

  
28
0. Definitions.
29

  
30
"This License" refers to version 3 of the GNU Affero General Public License.
31

  
32
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
33

  
34
"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.
35

  
36
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.
37

  
38
A "covered work" means either the unmodified Program or a work based on the Program.
39

  
40
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.
41

  
42
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.
43

  
44
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.
45

  
46
1. Source Code.
47
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.
48

  
49
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.
50

  
51
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.
52

  
53
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
54
subprograms and other parts of the work.
55

  
56
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
57

  
58
The Corresponding Source for a work in source code form is that same work.
59

  
60
2. Basic Permissions.
61
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.
62

  
63
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.
64

  
65
Conveying under any other circumstances is permitted solely under the conditions stated below.  Sublicensing is not allowed; section 10 makes it unnecessary.
66

  
67
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
68
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.
69

  
70
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.
71

  
72
4. Conveying Verbatim Copies.
73
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.
74

  
75
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.
76

  
77
5. Conveying Modified Source Versions.
78
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:
79

  
80
    a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
81

  
82
    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".
83

  
84
    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.
85

  
86
    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.
87

  
88
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.
89

  
90
6. Conveying Non-Source Forms.
91
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:
92

  
93
    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.
94

  
95
    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.
96

  
97
    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.
98

  
99
    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.
100

  
101
    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.
102

  
103
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.
104

  
105
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.
106

  
107
"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.
108

  
109
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).
110

  
111
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.
112

  
113
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.
114

  
115
7. Additional Terms.
116
"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.
117

  
118
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.
119

  
120
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:
121

  
122
    a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
123

  
124
    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
125

  
126
    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
127

  
128
    d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
129

  
130
    e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
131

  
132
    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.
133

  
134
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.
135

  
136
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.
137

  
138
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.
139

  
140
8. Termination.
141

  
142
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).
143

  
144
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.
145

  
146
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.
147

  
148
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.
149

  
150
9. Acceptance Not Required for Having Copies.
151

  
152
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.
153

  
154
10. Automatic Licensing of Downstream Recipients.
155

  
156
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.
157

  
158
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.
159

  
160
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.
161

  
162
11. Patents.
163

  
164
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".
165

  
166
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.
167

  
168
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.
169

  
170
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.
171

  
172
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
173
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.
174

  
175
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.
176

  
177
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.
178

  
179
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.
180

  
181
12. No Surrender of Others' Freedom.
182

  
183
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
184
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.
185

  
186
13. Remote Network Interaction; Use with the GNU General Public License.
187

  
188
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software.  This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
189

  
190
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 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 work with which it is combined will remain governed by version 3 of the GNU General Public License.
191

  
192
14. Revised Versions of this License.
193

  
194
The Free Software Foundation may publish revised and/or new versions of the GNU Affero 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.
195

  
196
Each version is given a distinguishing version number.  If the Program specifies that a certain numbered version of the GNU Affero 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 Affero General Public License, you may choose any version ever published by the Free Software Foundation.
197

  
198
If the Program specifies that a proxy can decide which future versions of the GNU Affero 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.
199

  
200
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.
201

  
202
15. Disclaimer of Warranty.
203

  
204
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.
205

  
206
16. Limitation of Liability.
207

  
208
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.
209

  
210
17. Interpretation of Sections 15 and 16.
211

  
212
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.
213

  
214
END OF TERMS AND CONDITIONS
215

  
216
            How to Apply These Terms to Your New Programs
217

  
218
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.
219

  
220
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.
221

  
222
     <one line to give the program's name and a brief idea of what it does.>
223
     Copyright (C) <year>  <name of author>
224

  
225
     This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
226

  
227
     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 Affero General Public License for more details.
228

  
229
     You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.
230

  
231
Also add information on how to contact you by electronic and paper mail.
232

  
233
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source.  For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code.  There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
234

  
235
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 AGPL, see <http://www.gnu.org/licenses/>.
LICENSES/CC0-1.0.txt
1
Creative Commons Legal Code
2

  
3
CC0 1.0 Universal
4

  
5
    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6
    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7
    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8
    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9
    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10
    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11
    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12
    HEREUNDER.
13

  
14
Statement of Purpose
15

  
16
The laws of most jurisdictions throughout the world automatically confer
17
exclusive Copyright and Related Rights (defined below) upon the creator
18
and subsequent owner(s) (each and all, an "owner") of an original work of
19
authorship and/or a database (each, a "Work").
20

  
21
Certain owners wish to permanently relinquish those rights to a Work for
22
the purpose of contributing to a commons of creative, cultural and
23
scientific works ("Commons") that the public can reliably and without fear
24
of later claims of infringement build upon, modify, incorporate in other
25
works, reuse and redistribute as freely as possible in any form whatsoever
26
and for any purposes, including without limitation commercial purposes.
27
These owners may contribute to the Commons to promote the ideal of a free
28
culture and the further production of creative, cultural and scientific
29
works, or to gain reputation or greater distribution for their Work in
30
part through the use and efforts of others.
31

  
32
For these and/or other purposes and motivations, and without any
33
expectation of additional consideration or compensation, the person
34
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35
is an owner of Copyright and Related Rights in the Work, voluntarily
36
elects to apply CC0 to the Work and publicly distribute the Work under its
37
terms, with knowledge of his or her Copyright and Related Rights in the
38
Work and the meaning and intended legal effect of CC0 on those rights.
39

  
40
1. Copyright and Related Rights. A Work made available under CC0 may be
41
protected by copyright and related or neighboring rights ("Copyright and
42
Related Rights"). Copyright and Related Rights include, but are not
43
limited to, the following:
44

  
45
  i. the right to reproduce, adapt, distribute, perform, display,
46
     communicate, and translate a Work;
47
 ii. moral rights retained by the original author(s) and/or performer(s);
48
iii. publicity and privacy rights pertaining to a person's image or
49
     likeness depicted in a Work;
50
 iv. rights protecting against unfair competition in regards to a Work,
51
     subject to the limitations in paragraph 4(a), below;
52
  v. rights protecting the extraction, dissemination, use and reuse of data
53
     in a Work;
54
 vi. database rights (such as those arising under Directive 96/9/EC of the
55
     European Parliament and of the Council of 11 March 1996 on the legal
56
     protection of databases, and under any national implementation
57
     thereof, including any amended or successor version of such
58
     directive); and
59
vii. other similar, equivalent or corresponding rights throughout the
60
     world based on applicable law or treaty, and any national
61
     implementations thereof.
62

  
63
2. Waiver. To the greatest extent permitted by, but not in contravention
64
of, applicable law, Affirmer hereby overtly, fully, permanently,
65
irrevocably and unconditionally waives, abandons, and surrenders all of
66
Affirmer's Copyright and Related Rights and associated claims and causes
67
of action, whether now known or unknown (including existing as well as
68
future claims and causes of action), in the Work (i) in all territories
69
worldwide, (ii) for the maximum duration provided by applicable law or
70
treaty (including future time extensions), (iii) in any current or future
71
medium and for any number of copies, and (iv) for any purpose whatsoever,
72
including without limitation commercial, advertising or promotional
73
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74
member of the public at large and to the detriment of Affirmer's heirs and
75
successors, fully intending that such Waiver shall not be subject to
76
revocation, rescission, cancellation, termination, or any other legal or
77
equitable action to disrupt the quiet enjoyment of the Work by the public
78
as contemplated by Affirmer's express Statement of Purpose.
79

  
80
3. Public License Fallback. Should any part of the Waiver for any reason
81
be judged legally invalid or ineffective under applicable law, then the
82
Waiver shall be preserved to the maximum extent permitted taking into
83
account Affirmer's express Statement of Purpose. In addition, to the
84
extent the Waiver is so judged Affirmer hereby grants to each affected
85
person a royalty-free, non transferable, non sublicensable, non exclusive,
86
irrevocable and unconditional license to exercise Affirmer's Copyright and
87
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88
maximum duration provided by applicable law or treaty (including future
89
time extensions), (iii) in any current or future medium and for any number
90
of copies, and (iv) for any purpose whatsoever, including without
91
limitation commercial, advertising or promotional purposes (the
92
"License"). The License shall be deemed effective as of the date CC0 was
93
applied by Affirmer to the Work. Should any part of the License for any
94
reason be judged legally invalid or ineffective under applicable law, such
95
partial invalidity or ineffectiveness shall not invalidate the remainder
96
of the License, and in such case Affirmer hereby affirms that he or she
97
will not (i) exercise any of his or her remaining Copyright and Related
98
Rights in the Work or (ii) assert any associated claims and causes of
99
action with respect to the Work, in either case contrary to Affirmer's
100
express Statement of Purpose.
101

  
102
4. Limitations and Disclaimers.
103

  
104
 a. No trademark or patent rights held by Affirmer are waived, abandoned,
105
    surrendered, licensed or otherwise affected by this document.
106
 b. Affirmer offers the Work as-is and makes no representations or
107
    warranties of any kind concerning the Work, express, implied,
108
    statutory or otherwise, including without limitation warranties of
109
    title, merchantability, fitness for a particular purpose, non
110
    infringement, or the absence of latent or other defects, accuracy, or
111
    the present or absence of errors, whether or not discoverable, all to
112
    the greatest extent permissible under applicable law.
113
 c. Affirmer disclaims responsibility for clearing rights of other persons
114
    that may apply to the Work or any use thereof, including without
115
    limitation any person's Copyright and Related Rights in the Work.
116
    Further, Affirmer disclaims responsibility for obtaining any necessary
117
    consents, permissions or other rights required for any use of the
118
    Work.
119
 d. Affirmer understands and acknowledges that Creative Commons is not a
120
    party to this document and has no duty or obligation with respect to
121
    this CC0 or use of the Work.
MANIFEST.in
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
include src/hydrilla_builder/schemas/package_source-*.schema.json*
8
include src/test/source-package-example/*
9
global-exclude .git .gitignore .gitmodules
README.md
1
TODO...
README.md.license
1
SPDX-License-Identifier: CC0-1.0
2

  
3
Copyright (C) 2022 Wojtek Kosior
4

  
5
Available under the terms of Creative Commons Zero v1.0 Universal.
pyproject.toml
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
[build-system]
8
build-backend = "setuptools.build_meta"
9
requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
10

  
11
[tool.setuptools_scm]
12
write_to = "src/hydrilla_builder/_version.py"
setup.cfg
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
[metadata]
8
name = hydrilla_builder
9
version = 1.0
10
author = Wojtek Kosior
11
author_email = koszko@koszko.org
12
description = Hydrilla package builder
13
long_description = file: README.md
14
long_description_content_type = text/markdown
15
url = https://git.koszko.org/hydrilla-builder
16
project_urls =
17
    Bug Tracker = https://hydrillabugs.koszko.org/projects/hydrilla
18
keywords = hydrilla, haketilo
19
license = AGPL-3.0-or-later
20
classifiers =
21
    Development Status :: 4 - Beta
22
    Intended Audience :: Developers
23
    Environment :: Console
24
    License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
25
    Natural Language :: English
26
    Operating System :: OS Independent
27
    Programming Language :: Python :: 3 :: Only
28
    Topic :: Software Development :: Build Tools
29

  
30
[options]
31
zip_safe = False
32
package_dir =
33
    = src
34
packages = find:
35
include_package_data=True
36
install_requires =
37
    click
38
    importlib; python_version == "2.6"
39
 # reuse is optional:
40
 #    reuse
41

  
42
[options.extras_require]
43
test = pytest
44
setup = setuptools_scm
45

  
46
[options.packages.find]
47
where = src
48
exclude =
49
    test
50

  
51
[options.entry_points]
52
console_scripts =
53
    hydrilla-builder = __main__:perform_build
setup.py
1
#!/usr/bin/env python3
2
# SPDX-License-Identifier: CC0-1.0
3

  
4
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
5
#
6
# Available under the terms of Creative Commons Zero v1.0 Universal.
7

  
8
import setuptools
9

  
10
setuptools.setup(package_data={'hydrilla_builder': ['*.json']})
src/conftest.py
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
src/hydrilla_builder/__init__.py
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
src/hydrilla_builder/__main__.py
1
# SPDX-License-Identifier: AGPL-3.0-or-later
2

  
3
# Command line interface of Hydrilla package builder.
4
#
5
# This file is part of Hydrilla
6
#
7
# Copyright (C) 2022 Wojtek Kosior
8
#
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU Affero General Public License as
11
# published by the Free Software Foundation, either version 3 of the
12
# License, or (at your option) any later version.
13
#
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
# GNU Affero General Public License for more details.
18
#
19
# You should have received a copy of the GNU Affero General Public License
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
21
#
22
#
23
# I, Wojtek Kosior, thereby promise not to sue for violation of this
24
# file's license. Although I request that you do not make use this code
25
# in a proprietary program, I am not going to enforce this in court.
26

  
27
from pathlib import Path
28

  
29
import click
30

  
31
from .build import Build
32

  
33
def validate_dir_path(ctx, param, value):
34
    path = Path(value)
35
    if path.is_dir():
36
        return path.resolve()
37

  
38
    raise click.BadParameter(f'{param.human_readable_name} must be a directory path')
39

  
40
def validate_path(ctx, param, value):
41
    return Path(value)
42

  
43
@click.command()
44
@click.option('-s', '--srcdir', default='.', type=click.Path(),
45
              callback=validate_dir_path,
46
              help='Source directory to build from.')
47
@click.option('-i', '--index-json', default='index.json', type=click.Path(),
48
              callback=validate_path,
49
              help='Path to file to be processed instead of index.json (if not absolute, resolved relative to srcdir).')
50
@click.option('-d', '--dstdir', type=click.Path(), required=True,
51
              callback=validate_dir_path,
52
              help='Destination directory to write built package files to.')
53
def preform_build(srcdir, index_json, dstdir):
54
    """
55
    Build Hydrilla package from scrdir and write the resulting files under
56
    dstdir.
57
    """
58
    build = Build(srcdir, index_json)
59
    build.write_package_files(dstdir)
60

  
61
preform_build()
src/hydrilla_builder/build.py
1
# SPDX-License-Identifier: AGPL-3.0-or-later
2

  
3
# Building Hydrilla packages.
4
#
5
# This file is part of Hydrilla
6
#
7
# Copyright (C) 2021,2022 Wojtek Kosior
8
#
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU Affero General Public License as
11
# published by the Free Software Foundation, either version 3 of the
12
# License, or (at your option) any later version.
13
#
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
# GNU Affero General Public License for more details.
18
#
19
# You should have received a copy of the GNU Affero General Public License
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
21
#
22
#
23
# I, Wojtek Kosior, thereby promise not to sue for violation of this
24
# file's license. Although I request that you do not make use this code
25
# in a proprietary program, I am not going to enforce this in court.
26

  
27

  
28
import json
29
import re
30
import zipfile
31
from pathlib import Path
32
from hashlib import sha256
33
from sys import stderr
34

  
35
import jsonschema
36

  
37
here = Path(__file__).resolve().parent
38
with open(here / 'schemas' / 'package_source-1.schema.json') as schema_file:
39
    index_json_schema = json.load(schema_file)
40

  
41
class FileReferenceError(Exception):
42
    """
43
    Exception used to report various problems concerning files referenced from
44
    source package's index.json.
45
    """
46

  
47
class ReuseError(Exception):
48
    """
49
    Exception used to report various problems when calling the REUSE tool.
50
    """
51

  
52
strip_comment_re = re.compile(r'''
53
^ # match from the beginning of each line
54
( # catch the part before '//' comment
55
  (?: # this group matches either a string or a single out-of-string character
56
    [^"/] |
57
    "
58
    (?: # this group matches any in-a-string character
59
      [^"\\] |          # match any normal character
60
      \\[^u] |          # match any escaped character like '\f' or '\n'
61
      \\u[a-fA-F0-9]{4} # match an escape
62
    )*
63
    "
64
  )*
65
)
66
# expect either end-of-line or a comment:
67
# * unterminated strings will cause matching to fail
68
# * bad comment (with '/' instead of '//') will be indicated by second group
69
#   having length 1 instead of 2 or 0
70
(//?|$)
71
''', re.VERBOSE)
72

  
73
def strip_json_comments(text):
74
    """
75
    Accept JSON text with optional C++-style ('//') comments and return the text
76
    with comments removed. Consecutive slashes inside strings are handled
77
    properly. A spurious single slash ('/') shall generate an error. Errors in
78
    JSON itself shall be ignored.
79
    """
80
    processed = 0
81
    stripped_text = []
82
    for line in text.split('\n'):
83
        match = strip_comment_re.match(line)
84

  
85
        if match is None: # unterminated string
86
            # ignore this error, let json module report it
87
            stripped = line
88
        elif len(match[2]) == 1:
89
            raise json.JSONDecodeError('bad comment', text,
90
                                       processed + len(match[1]))
91
        else:
92
            stripped = match[1]
93

  
94
        stripped_text.append(stripped)
95
        processed += len(line) + 1
96

  
97
    return '\n'.join(stripped_text)
98

  
99
def normalize_version(ver):
100
    '''
101
    'ver' is an array of integers. Strip right-most zeroes from ver.
102

  
103
    Returns a *new* array. Doesn't modify its argument.
104
    '''
105
    new_len = 0
106
    for i, num in enumerate(ver):
107
        if num != 0:
108
            new_len = i + 1
109

  
110
    return ver[:new_len]
111

  
112
class FileBuffer:
113
    """
114
    Implement a file-like object that buffers data written to it.
115
    """
116
    def __init__(self):
117
        """
118
        Initialize FileBuffer.
119
        """
120
        self.chunks = []
121

  
122
    def write(self, b):
123
        """
124
        Buffer 'b', return number of bytes buffered.
125

  
126
        'b' is expected to be an instance of 'bytes' or 'str', in which case it
127
        gets encoded as UTF-8.
128
        """
129
        if type(b) is str:
130
            b = b.encode()
131
        self.chunks.append(b)
132
        return len(b)
133

  
134
    def flush(self):
135
        """
136
        A no-op mock of file-like object's flush() method.
137
        """
138
        pass
139

  
140
    def get_bytes(self):
141
        """
142
        Return all data written so far concatenated into a single 'bytes'
143
        object.
144
        """
145
        return b''.join(self.chunks)
146

  
147
def generate_spdx_report(root):
148
    """
149
    Use REUSE tool to generate an SPDX report for sources under 'root' and
150
    return the report's contents as 'bytes'.
151

  
152
    'root' shall be an instance of pathlib.Path.
153

  
154
    In case the directory tree under 'root' does not constitute a
155
    REUSE-compliant package, linting report is printed to standard output and
156
    an exception is raised.
157

  
158
    In case the reuse package is not installed, an exception is also raised.
159
    """
160
    try:
161
        from reuse._main import main as reuse_main
162
    except ModuleNotFoundError:
163
        ReuseError("Could not import 'reuse'. Is the tool installed and visible to this Python instance?")
164

  
165
    mocked_output = FileBuffer()
166
    if reuse_main(args=['--root', str(root), 'lint'], out=mocked_output) != 0:
167
        stderr.write(mocked_out.get_bytes())
168
        raise ReuseError('Attempt to generate an SPDX report for a REUSE-incompliant package.')
169

  
170
    mocked_output = FileBuffer()
171
    if reuse_main(args=['--root', str(root), 'spdx'], out=mocked_output) != 0:
172
        stderr.write(mocked_out.get_bytes())
173
        raise ReuseError("Couldn't generate an SPDX report for package.")
174

  
175
    return mocked_output.get_bytes()
176

  
177
class FileRef:
178
    """Represent reference to a file in the package."""
179
    def __init__(self, path: Path, contents: bytes):
180
        """Initialize FileRef."""
181
        self.include_in_distribution = False
182
        self.include_in_zipfile      = True
183
        self.path                    = path
184
        self.contents                = contents
185

  
186
        self.contents_hash = sha256(contents).digest().hex()
187

  
188
    def make_ref_dict(self, filename: str):
189
        """
190
        Represent the file reference through a dict that can be included in JSON
191
        defintions.
192
        """
193
        return {
194
            'file':   filename,
195
            'sha256': self.contents_hash
196
        }
197

  
198
class Build:
199
    """
200
    Build a Hydrilla package.
201
    """
202
    def __init__(self, srcdir, index_json_path):
203
        """
204
        Initialize a build. All files to be included in a distribution package
205
        are loaded into memory, all data gets validated and all necessary
206
        computations (e.g. preparing of hashes) are performed.
207

  
208
        'srcdir' and 'index_json' are expected to be pathlib.Path objects.
209
        """
210
        self.srcdir          = srcdir.resolve()
211
        self.index_json_path = index_json_path
212
        self.files_by_path   = {}
213
        self.resource_list   = []
214
        self.mapping_list    = []
215

  
216
        if not index_json_path.is_absolute():
217
            self.index_json_path = (self.srcdir / self.index_json_path)
218

  
219
        self.index_json_path = self.index_json_path.resolve()
220

  
221
        with open(self.index_json_path, 'rt') as index_file:
222
            index_json_text = index_file.read()
223

  
224
        index_obj = json.loads(strip_json_comments(index_json_text))
225

  
226
        self.files_by_path[self.index_json_path] = \
227
            FileRef(self.index_json_path, index_json_text.encode())
228

  
229
        self._process_index_json(index_obj)
230

  
231
    def _process_file(self, filename: str, include_in_distribution: bool=True):
232
        """
233
        Resolve 'filename' relative to srcdir, load it to memory (if not loaded
234
        before), compute its hash and store its information in
235
        'self.files_by_path'.
236

  
237
        'filename' shall represent a relative path using '/' as a separator.
238

  
239
        if 'include_in_distribution' is True it shall cause the file to not only
240
        be included in the source package's zipfile, but also written as one of
241
        built package's files.
242

  
243
        Return file's reference object that can be included in JSON defintions
244
        of various kinds.
245
        """
246
        path = self.srcdir
247
        for segment in filename.split('/'):
248
            path /= segment
249

  
250
        path = path.resolve()
251
        if not path.is_relative_to(self.srcdir):
252
            raise FileReferenceException(f"Attempt to load '{filename}' which lies outside package source directory.")
253

  
254
        if path == self.index_json_path:
255
            raise FileReferenceException("Attempt to load 'index.json' which is a reserved filename.")
256

  
257
        file_ref = self.files_by_path.get(path)
258
        if file_ref is None:
259
            with open(path, 'rb') as file_handle:
260
                contents = file_handle.read()
261

  
262
            file_ref = FileRef(path, contents)
263
            self.files_by_path[path] = file_ref
264

  
265
        if include_in_distribution:
266
            file_ref.include_in_distribution = True
267

  
268
        return file_ref.make_ref_dict(filename)
269

  
270
    def _prepare_source_package_zip(self, root_dir_name: str):
271
        """
272
        Create and store in memory a .zip archive containing files needed to
273
        build this source package.
274

  
275
        'root_dir_name' shall not contain any slashes ('/').
276

  
277
        Return zipfile's sha256 sum's hexstring.
278
        """
279
        fb = FileBuffer()
280
        root_dir_path = Path(root_dir_name)
281

  
282
        def zippath(file_path):
283
            return str(root_dir_path / file_path.relative_to(self.srcdir))
284

  
285
        with zipfile.ZipFile(fb, 'w') as xpi:
286
            for file_ref in self.files_by_path.values():
287
                if file_ref.include_in_zipfile:
288
                    xpi.writestr(zippath(file_ref.path), file_ref.contents)
289

  
290
        self.source_zip_contents = fb.get_bytes()
291

  
292
        return sha256(self.source_zip_contents).digest().hex()
293

  
294
    def _process_item(self, item_def: dict):
295
        """
296
        Process 'item_def' as definition of a resource/mapping and store in
297
        memory its processed form and files used by it.
298
        """
299
        copy_props = ['type', 'identifier', 'long_name', 'uuid', 'description']
300
        if 'comment' in item_def:
301
            copy_props.append(copy_props)
302

  
303
        if item_def['type'] == 'resource':
304
            item_list = self.resource_list
305

  
306
            copy_props.append('revision')
307

  
308
            script_file_refs = [self._process_file(f['file'])
309
                                for f in item_def.get('scripts', [])]
310

  
311
            new_item_obj = {
312
                'dependencies': item_def.get('dependencies', []),
313
                'scripts':      script_file_refs
314
            }
315
        else:
316
            item_list = self.mapping_list
317

  
318
            payloads = dict([(pat, {'identifier': res_ref['identifier']})
319
                             for pat, res_ref in item_def['payloads'].items()])
320

  
321
            new_item_obj = {
322
                'payloads': payloads
323
            }
324

  
325
        new_item_obj.update([(p, item_def[p]) for p in copy_props])
326

  
327
        new_item_obj['version'] = normalize_version(item_def['version'])
328
        new_item_obj['api_schema_version'] = [1, 0, 1]
329

  
330
        item_list.append(new_item_obj)
331

  
332
    def _process_index_json(self, index_obj: dict):
333
        """
334
        Process 'index_obj' as contents of source package's index.json and store
335
        in memory this source package's zipfile as well as package's individual
336
        files and computed definitions of the source package and items defined
337
        in it.
338
        """
339
        jsonschema.validate(index_obj, index_json_schema)
340

  
341
        generate_spdx = index_obj.get('reuse_generate_spdx_report', False)
342
        if generate_spdx:
343
            contents  = generate_spdx_report(self.srcdir)
344
            spdx_path = (self.srcdir / 'report.spdx').resolve()
345
            spdx_ref  = FileRef(spdx_path, contents)
346

  
347
            spdx_ref.include_in_zipfile = False
348
            self.files_by_path[spdx_path] = spdx_ref
349

  
350
        copyright_file_refs = \
351
            [self._process_file(f['file']) for f in index_obj['copyright']]
352

  
353
        if generate_spdx and not spdx_ref.include_in_distribution:
354
            raise FileReferenceError("Told to generate 'report.spdx' but 'report.spdx' is not listed among copyright files. Refusing to proceed.")
355

  
356
        item_refs = [self._process_item(d) for d in index_obj['definitions']]
357

  
358
        for file_ref in index_obj.get('additional_files', []):
359
            self._process_file(file_ref['file'], include_in_distribution=False)
360

  
361
        root_dir_path = Path(index_obj['source_name'])
362

  
363
        source_archives_obj = {
364
            'zip' : {
365
                'sha256': self._prepare_source_package_zip(root_dir_path)
366
            }
367
        }
368

  
369
        self.source_description = {
370
            'api_schema_version': [1, 0, 1],
371
            'source_name':        index_obj['source_name'],
372
            'source_copyright':   copyright_file_refs,
373
            'upstream_url':       index_obj['upstream_url'],
374
            'definitions':        item_refs,
375
            'source_archives':    source_archives_obj
376
        }
377

  
378
    def write_source_package_zip(self, dstpath: Path):
379
        """
380
        Create a .zip archive containing files needed to build this source
381
        package and write it at 'dstpath'.
382
        """
383
        with open(dstpath, 'wb') as output:
384
            output.write(self.source_zip_contents)
385

  
386
    def write_package_files(self, dstpath: Path):
387
        """Write package files under 'dstpath' for distribution."""
388
        file_dir_path = (dstpath / 'file').resolve()
389
        file_dir_path.mkdir(parents=True, exist_ok=True)
390

  
391
        for file_ref in self.files_by_path.values():
392
            if file_ref.include_in_distribution:
393
                file_name = f'sha256-{file_ref.contents_hash}'
394
                with open(file_dir_path / file_name, 'wb') as output:
395
                    output.write(file_ref.contents)
396

  
397
        source_dir_path = (dstpath / 'source').resolve()
398
        source_dir_path.mkdir(parents=True, exist_ok=True)
399
        source_name = self.source_description["source_name"]
400

  
401
        with open(source_dir_path / f'{source_name}.json', 'wt') as output:
402
            json.dump(self.source_description, output)
403

  
404
        with open(source_dir_path / f'{source_name}.zip', 'wb') as output:
405
            output.write(self.source_zip_contents)
406

  
407
        for item_type, item_list in [
408
                ('resource', self.resource_list),
409
                ('mapping', self.mapping_list)
410
        ]:
411
            item_type_dir_path = (dstpath / item_type).resolve()
412

  
413
            for item_def in item_list:
414
                item_dir_path = item_type_dir_path / item_def['identifier']
415
                item_dir_path.mkdir(parents=True, exist_ok=True)
416

  
417
                version = '.'.join([str(n) for n in item_def['version']])
418
                with open(item_dir_path / version, 'wt') as output:
419
                    json.dump(item_def, output)
src/hydrilla_builder/schemas
1
Subproject commit 7ce7ee1a4821b23909c07491798083c4b3639f98
src/test/source-package-example
1
Subproject commit 96b8830c30d9052decaf9aaf99375cf4b5ad719f
src/test/test_hydrilla_builder.py
1
# SPDX-License-Identifier: CC0-1.0
2

  
3
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
4
#
5
# Available under the terms of Creative Commons Zero v1.0 Universal.
6

  
7
import pytest
8

  
9
from tempfile import TemporaryDirectory
10
from pathlib import Path
11

  
12
here = Path(__file__).resolve().parent
13

  
14
@pytest.fixture()
15
def tmpdir():
16
    with TemporaryDirectory() as tmpdir:
17
        yield tmpdir
18

  
19
def test_build(tmpdir):
20
    """Build the sample source package and verify the produced files."""
21
    from hydrilla_builder.build import Build
22

  
23
    build = Build(here / 'source-package-example', Path('index.json'))
24
    build.write_package_files(Path(tmpdir))
25

  
26
    # TODO: verify results

Also available in: Unified diff