├── .gitignore ├── .travis.yml ├── COPYING ├── README.md └── darbrrb.py /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | __pycache__ 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "3.3" 4 | - "3.5" 5 | install: "pip install nose2" 6 | script: "nose2 -v darbrrb" 7 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | darbrrb 2 | ======= 3 | 4 | [![Build Status](https://travis-ci.org/jaredjennings/darbrrb.svg?branch=master)](https://travis-ci.org/jaredjennings/darbrrb) 5 | 6 | This is dar-based Blu-Ray redundant backup. It exists to back up a few 7 | hundred gigabytes of data onto dozens of optical discs in a way that 8 | it can be restored ten years later. 9 | 10 | Setting 11 | ------- 12 | 13 | I've got a few hundred gigabytes of data and a fireproof box. The 14 | directions say not to put a hard drive in the box and expect it to 15 | work after a fire. My data is on an LVM logical volume, so I can make 16 | a snapshot to ensure it won't change during backup. This is my data 17 | I'm backing up, not my system, so I don't need bare-metal restore. 18 | 19 | Problems 20 | -------- 21 | 22 | When I tried to restore my DVD backup from six years ago, made with 23 | dar and par2: 24 | 25 | 1. I couldn't figure out how I ran dar to make the backup, nor how to 26 | run it to restore the files. 27 | 28 | 2. Half the DVDs had scratches or media decay, and on those discs I/O 29 | errors caused the copying of the single, giant 4.5GB file to stop 30 | halfway through. 31 | 32 | 3. I had par2 files that gave me 5% data redundancy. These were not 33 | enough, and they were on the same disc as the data that was lost. 34 | 35 | 4. Nothing could save me if I had lost a whole disc containing a file 36 | I wanted. 37 | 38 | 5. Once I figured out how the backup was made, I found that current 39 | versions of dar and par2 work as well as could be expected with the 40 | incomplete data I had. 41 | 42 | Solutions 43 | --------- 44 | 45 | To prevent the reoccurrence of these problems, darbrrb is designed in 46 | the following ways: 47 | 48 | 1. darbrrb puts a copy of itself, including vital parameters used to 49 | run it, on every backup disc. 50 | 51 | 2. darbrrb uses dar slice files smaller than the disc, and spreads the 52 | slices over sets of discs. 53 | 54 | 3. darbrrb fills one or more of the discs in a set entirely with 55 | redundancy data: like RAID, but with optical discs, and a 56 | configurable number of spare discs. 57 | 58 | 4. darbrrb uses [dar](http://dar.linux.free.fr) and 59 | [par](http://en.wikipedia.org/wiki/Parchive) 1 because they seem 60 | likely to be fetchable and usable in ten years. 61 | 62 | What is it? 63 | ----------- 64 | 65 | darbrrb is a single script, written in Python 3, which wraps dar and 66 | parchive. dar provides a hook, where a program can be run every time dar 67 | finishes a slice; darbrrb hooks into this to make the redundancy data 68 | at the proper times, and burn discs using growisofs. 69 | 70 | -------------------------------------------------------------------------------- /darbrrb.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # darbrrb.py: dar-based blu-ray redundant backup. 3 | # Copyright 2013, Jared Jennings . 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | # --- 19 | # 20 | # See usage function below for documentation, or run this script with no 21 | # arguments. 22 | # 23 | # Imports are below the settings. 24 | 25 | darrc_template = """ 26 | --min-digits={settings.digits} 27 | --slice {settings.slice_size_KiB:0.0f}K 28 | # make crypto block size larger to reduce 29 | # likelihood of duplicate ciphertext 30 | --crypto-block 131072 31 | # DO NOT specify the AES key here: this script is burned on every 32 | # backup disc, in the clear 33 | --key aes: 34 | # don't back up caches, e.g. Firefox cache 35 | --cache-directory-tagging 36 | -v 37 | create: 38 | --compression=bzip2 39 | -E "python3 {progname} {progargs} _create %p %b %n %e %c" 40 | extract: 41 | -O 42 | -E "python3 {progname} {progargs} _extract %p %b %n %e %c" 43 | list: 44 | -E "python3 {progname} {progargs} _list %p %b %n %e %c" 45 | test: 46 | -E "python3 {progname} {progargs} _test %p %b %n %e %c" 47 | isolate: 48 | -E "python3 {progname} {progargs} _isolate %p %b %n %e %c" 49 | """ 50 | 51 | class Settings: 52 | # vvvvvvvv Below are variables for you to mess with vvvvvvvvvvvvv 53 | 54 | burner_device = '/dev/null' 55 | 56 | # SCRATCH_DIR must have (DATA_DISCS + PARITY_DISCS) * DISC_SIZE mebibytes free 57 | # to run backup. SCRATCH_DIR must not exist when this script is run. 58 | # SCRATCH_DIR must not be a subdirectory of the directory being backed up. 59 | scratch_dir = '/home/tmp/backup_scratch' 60 | 61 | # This ballpark figure is used to calculate the number of digits to 62 | # use when numbering archive slices. 63 | expected_data_size_GiB = 500.0 64 | 65 | # Each redundancy set is composed of (DATA_DISCS + PARITY_DISCS) discs. 66 | # These are like hard disk shelves with RAID, but with discs instead. 67 | data_discs = 3 68 | parity_discs = 2 69 | 70 | # How many slices should be on each disc? I/O errors caused by media 71 | # decay can truncate a slice; PAR1 then can't use the whole file. So 72 | # let's be slightly wasteful. 73 | slices_per_disc = 500 74 | 75 | # How much space is on a disc? 76 | # BluRay 77 | # https://superuser.com/a/565999 "256MB for defect management" 78 | disc_size_MiB = 23841 - 256 79 | # DVD 80 | ## disc_size_MiB = 4482 81 | # CD-R 82 | ## disc_size_MiB = 680 83 | 84 | 85 | # ^^^^^^^^ Above are variables for you to mess with ^^^^^^^^^^^ 86 | 87 | # Reserved space is used for the filesystem, a copy of this program, a 88 | # README, and the par file that lists redundancy files. 89 | # Starting from http://stackoverflow.com/questions/468117, observed ISO + 90 | # Rock Ridge + Joliet filesystem overhead at 362K + 1.7K per filename. 91 | reserve_space_KiB = 10240 92 | 93 | # calculated settings 94 | 95 | @property 96 | def slices_per_set(self): 97 | return self.data_discs * self.slices_per_disc 98 | 99 | @property 100 | def total_set_count(self): 101 | return self.data_discs + self.parity_discs 102 | 103 | @property 104 | def scratch_free_needed_MiB(self): 105 | return self.total_set_count * self.disc_size_MiB 106 | 107 | def _calculate_digits(self): 108 | expected_frac_slices = (self.expected_data_size_GiB * 1024.0 * 109 | self.slices_per_disc) / self.disc_size_MiB 110 | expected_slices = int(expected_frac_slices + 1) 111 | return len(str(expected_slices)) + 1 112 | def _set_digits(self, new_value): 113 | self._digits = new_value 114 | def _get_digits(self): 115 | if not hasattr(self, '_digits'): 116 | self._digits = self._calculate_digits() 117 | return self._digits 118 | # make digits settable so the unit tests can just set it without 119 | # worrying about what the right value of expected_data_size is for 120 | # their fantastic scenarios 121 | digits = property(_get_digits, _set_digits) 122 | 123 | @property 124 | def number_format(self): 125 | return '{:0' + str(self.digits) + '}' 126 | 127 | @property 128 | def _slice_size_not_counting_par_overhead_KiB(self): 129 | return ((self.disc_size_KiB - self.reserve_space_KiB) // 130 | self.slices_per_disc) 131 | 132 | @property 133 | def slice_size_KiB(self): 134 | # This allows for 32-character dar slice filenames. 135 | par_header_bytes = 96 + 120 * self.data_discs 136 | # Each pXX file has a par header; and for each data_discs 137 | # slices, there's a par file 138 | par_overhead_bytes = par_header_bytes * (1 + 1 / self.data_discs) 139 | par_overhead_KiB = (par_overhead_bytes + 1024) // 1024 140 | return self._slice_size_not_counting_par_overhead_KiB - par_overhead_KiB 141 | 142 | # auto-convert between _KiB and _MiB 143 | def __getattr__(self, name): 144 | if name in dir(self): 145 | return getattr(super(), name) 146 | else: 147 | if name.endswith('_MiB'): 148 | as_KiB = name.replace('_MiB', '_KiB') 149 | if as_KiB in dir(self): 150 | return getattr(self, as_KiB) / 1024 151 | elif name.endswith('_KiB'): 152 | as_MiB = name.replace('_KiB', '_MiB') 153 | if as_MiB in dir(self): 154 | return getattr(self, as_MiB) * 1024 155 | raise AttributeError(name) 156 | 157 | # -n switch turns this off 158 | actually_burn = True 159 | 160 | 161 | 162 | from itertools import chain 163 | import sys 164 | import os 165 | import shutil 166 | import glob 167 | import getopt 168 | import subprocess 169 | import tempfile 170 | import contextlib 171 | import unittest 172 | import logging 173 | import io 174 | import re 175 | import itertools 176 | import random 177 | import math 178 | import pickle 179 | import base64 180 | try: 181 | from unittest.mock import Mock, patch, sentinel, call 182 | except ImportError: 183 | from mock import Mock, patch, sentinel, call 184 | 185 | 186 | def usage(settings): 187 | print(""" 188 | This script makes compressed, encrypted backups with {s.slice_size_MiB:0.2f} MiB \ 189 | slices striped 190 | across sets of {s.total_set_count} {s.disc_size_MiB} MiB optical discs, \ 191 | each set containing {s.data_discs} data disc(s) 192 | and {s.parity_discs} parity disc(s). It \ 193 | requires the following software (or later versions): 194 | Python 3.2; mock 1.0 (included in Python 3.3); dar 2.5.4*; parchive 1.1; 195 | growisofs 7.1; genisoimage 1.1.11. 196 | 197 | * If you are encrypting, you need change 8e64f413. If you have dar 198 | 2.5.4 or later, you have change 8e64f413. If you don't (2.5.4 is not 199 | yet released as of March 2016), you will need to build the 200 | branch_2.5.x branch of dar yourself. See 201 | and 202 | . 203 | If you are not using encryption, any recent dar will do (2.4.8 did 204 | fine without encryption, for example). 205 | 206 | When backing up, the directory {s.scratch_dir!r} should have 207 | {s.scratch_free_needed_MiB} MiB of space free. \ 208 | When restoring, copy this script off of the optical 209 | disc first; you'll need to switch optical discs during the backup. 210 | 211 | If you don't like any of these settings, change this script. The 212 | settings are toward the top. 213 | 214 | Usage: python3 {progname} [-v] [-n] dar 215 | 216 | Dar parameters of note: 217 | Creating archive: -c -R 218 | Extracting archive: -x 219 | 220 | You get 23 characters for the archive basename. (Sorry, that's ISO 221 | 9660.) See dar(1) about parameters you can give to dar. Don't get 222 | fancy: only use the ones that tell dar which mode to operate in, and 223 | which files to archive. Otherwise this script will not form a 224 | complete record of how dar was run. 225 | 226 | The -v switch, before dar, means to be verbose and show the dar command 227 | being executed and the darrc used. The -n switch, before dar, means don't 228 | burn any discs: just make directories containing the files that would have 229 | been burned. (This can use much more scratch space.) 230 | 231 | """.format(s=settings, progname=sys.argv[0]), 232 | file=sys.stderr) 233 | 234 | 235 | @contextlib.contextmanager 236 | def working_directory(newcwd): 237 | oldcwd = os.getcwd() 238 | try: 239 | os.chdir(newcwd) 240 | yield 241 | finally: 242 | os.chdir(oldcwd) 243 | 244 | class NotEnoughScratchSpace(Exception): 245 | pass 246 | 247 | class ScratchAlreadyExists(Exception): 248 | pass 249 | 250 | parity_volume_re = re.compile(r'.*\.[pqr][0-9][0-9]') 251 | 252 | # This is a class not because it needs state, but because I didn't want to pass 253 | # settings around all the time 254 | class Darbrrb: 255 | def __init__(self, settings, progname, progopts=()): 256 | self.settings = settings 257 | self.progname = progname 258 | self.progopts = progopts 259 | self.log = logging.getLogger('darbrrb') 260 | 261 | def _run(self, *args): 262 | try_again = True 263 | while try_again: 264 | self.log.info('running command {!r}'.format(args)) 265 | try: 266 | subprocess.check_call(args) 267 | try_again = False 268 | except subprocess.CalledProcessError as e: 269 | self.log.exception('an error was encountered ' 270 | 'when running command {!r}'.format(args)) 271 | valid_input = False 272 | while not valid_input: 273 | the_input = input('Something went wrong ' 274 | 'when running command {!r}. ' 275 | 'Try again? [Y/n] '.format(args)) 276 | if the_input == '': 277 | valid_input = True 278 | try_again = True 279 | elif (the_input.startswith('y') or 280 | the_input.startswith('Y')): 281 | valid_input = True 282 | try_again = True 283 | elif (the_input.startswith('n') or 284 | the_input.startswith('N')): 285 | valid_input = True 286 | try_again = False 287 | self.log.error('re-raising the error') 288 | raise 289 | if not valid_input: 290 | print('Did not understand your input. Asking again.') 291 | 292 | # for mockability 293 | def _copy(self, source, destination): 294 | shutil.copyfile(source, destination) 295 | 296 | @property 297 | def darrc_contents(self): 298 | progargs = [] 299 | for o, v in self.progopts: 300 | if v: 301 | progargs.extend(o, v) 302 | else: 303 | progargs.append(o) 304 | return darrc_template.format(settings=self.settings, 305 | progname=os.path.join(self.settings.scratch_dir, 306 | os.path.basename(self.progname)), 307 | progargs=' '.join(progargs)) 308 | 309 | def readme(self, basename): 310 | if 'DARBRRB_ORIGINAL_ARGV' in os.environ: 311 | try: 312 | original_argv = pickle.loads( 313 | base64.b64decode(os.environ['DARBRRB_ORIGINAL_ARGV'])) 314 | except: 315 | original_argv = ['there was an error trying to find out'] 316 | else: 317 | original_argv = ['not known'] 318 | return """ 319 | 320 | This disc is part of a backup made by darbrrb, a tool that wraps the dar disk 321 | archiver and the parchive file verification and repair tool to produce backups 322 | with redundancy, for greater resilience against data loss due to backup media 323 | failures or losses. 324 | 325 | The {progname} script you find on this disc is a copy of the one used to make 326 | the backup; some salient settings are written toward the top of this file. 327 | 328 | darbrrb was run with these arguments: 329 | 330 | {argv!r} 331 | 332 | darbrrb ran dar with this darrc: 333 | 334 | # ---------------- 335 | {contents} 336 | # ---------------- 337 | 338 | The backup is split into redundancy sets of {s.total_set_count} discs. Out of 339 | each set, dar archive slices are striped across the {s.data_discs} data 340 | disc(s); par files with parity data for the dar slices are striped across the 341 | {s.parity_discs} disc(s). Each disc can store {s.disc_size_MiB} MiB of data, and 342 | each slice is {s.slice_size_MiB:0.2f} MiB in size. 343 | 344 | To restore some files: first, make a directory somewhere with at least 345 | {s.scratch_free_needed_MiB:0.0f} MiB free. Copy this script from a disc of the backup 346 | into your directory. Run it with arguments like those above, but replace the 347 | -c with a -x (you are extracting an archive instead of creating it), and 348 | replace the value of the -R switch, which was the directory where all the 349 | files were backed up from, with the directory to which you want the files 350 | restored. 351 | 352 | You'll be asked for discs from the backup. 353 | 354 | About the files that may be on this disc: 355 | 356 | * README.txt: this file. 357 | * {progname}: the darbrrb script used to make the backup. 358 | * {basename}.{one}.dar (e.g.): A dar slice file. This contains the data that 359 | was backed up. 360 | * {basename}.{one}-{fddn}.par (e.g.): a par index file for a parity volume 361 | set made over several dar slice files. It contains checksums for each of 362 | the slice files in the set. 363 | * {basename}.{one}-{fddn}.p01 (e.g.): a par parity volume file for the 364 | aforementioned parity volume set. This contains redundant data, such that 365 | if any of the dar slices in the set is missing or corrupted, it can be re- 366 | constructed. 367 | 368 | """.format(argv=original_argv, s=self.settings, 369 | contents=self.darrc_contents, 370 | progname=os.path.basename(self.progname), 371 | basename=basename, 372 | one=self.settings.number_format.format(1), 373 | fddn=self.settings.number_format.format(self.settings.data_discs)) 374 | # FIXME 375 | 376 | 377 | 378 | def dar(self, *args): 379 | # Perhaps darrc files can be non-ascii, but we haven't got any 380 | # non-ascii arguments to give here, so we'll stay on the safe side. 381 | indented_contents = self.darrc_contents.replace('\n', '\n ') 382 | with open(os.path.join(self.settings.scratch_dir, 'darrc'), 383 | 'w', encoding='ascii') as darrc_file: 384 | self.log.info("""Contents of {name} follow: 385 | {indented} 386 | """.format(name=darrc_file.name, indented=indented_contents)) 387 | darrc_file.write(self.darrc_contents) 388 | darrc_file.flush() 389 | # causes of this working_directory: 390 | # 1. when dar makes files, it will make them in the scratch_dir 391 | # 2. when dar calls this script, the _create and other methods 392 | # below will have scratch_dir as their cwd. 393 | with working_directory(self.settings.scratch_dir): 394 | self._run('dar', *(args + ('-B', darrc_file.name))) 395 | 396 | def wait_for_empty_disc(self): 397 | # There are a hundred cooler ways to do this; in 2013, I don't know of 398 | # one that works on many distros and OSes, much less ten years from 399 | # now. But you'll probably still be able to press enter, some way. 400 | if self.settings.actually_burn: 401 | input("press enter when you have inserted an empty disc:") 402 | 403 | def written_disc_directory(self, disc_title): 404 | # Same as above. Now it's 2016, and all the ways I knew in 405 | # 2013 don't work any more, there are new ways. But you could 406 | # say "insert disc 2" in 1986, and you can say it today. And 407 | # get off my lawn! 408 | if self.settings.actually_burn: 409 | dir = input("insert and mount disc entitled {} and type the " 410 | "directory where its files can be found: ".format( 411 | disc_title)) 412 | return dir 413 | else: 414 | return os.path.join(self.settings.scratch_dir, disc_title) 415 | 416 | # zb: zero-based; ob: one-based 417 | 418 | def last_set_directory(self, basename, disc_number_in_set_zb): 419 | if self.settings.actually_burn: 420 | dir = input("insert and mount disc {} from the last set of " 421 | "backup {!r} and type the directory where its " 422 | "files can be found: ".format(disc_number_in_set_zb + 1, 423 | basename)) 424 | return dir 425 | else: 426 | dirs = glob.glob(os.path.join(self.settings.scratch_dir, 427 | basename + '-*')) 428 | last_disc_dir = sorted(dirs)[-1] 429 | disc_in_last_set_dir = '{}{:03d}'.format(last_disc_dir[:-3], 430 | disc_number_in_set_zb + 1) 431 | return disc_in_last_set_dir 432 | 433 | def disc_dir(self, disc): 434 | return '__disc{:04d}'.format(disc) 435 | 436 | def disc_dirs(self): 437 | return sorted(glob.glob('__disc*')) 438 | 439 | def disc_title(self, basename, set_number_zb, disc_in_set_number_zb): 440 | # Max ISO 9660 vol id length is 32. Leave room for numbers and 2 dashes. 441 | # +1: These numbers are 0-based, but we want the ones in the title 1-based. 442 | # If you change the format here, change code above in last_set_directory! 443 | return "{}-{:04d}-{:03d}".format(basename[:(32-4-3-2)], 444 | set_number_zb + 1, 445 | disc_in_set_number_zb + 1) 446 | 447 | def disc_title_for_slice(self, basename, dar_slice_number): 448 | set_number = math.floor((dar_slice_number - 1) / 449 | self.settings.slices_per_set) 450 | disc_in_set_number = ((dar_slice_number - 1) % 451 | self.settings.data_discs) 452 | return self.disc_title(basename, set_number, disc_in_set_number) 453 | 454 | def disc_title_for_slice_and_disc(self, basename, dar_slice_number_ob, disc_in_set_number_zb): 455 | set_number_zb = math.floor((dar_slice_number_ob - 1) / 456 | self.settings.slices_per_set) 457 | return self.disc_title(basename, set_number_zb, disc_in_set_number_zb) 458 | 459 | def scratch_free_MiB(self): 460 | s = os.statvfs(self.settings.scratch_dir) 461 | return s.f_bavail * s.f_frsize // 1048576 462 | 463 | def ensure_free_space(self): 464 | free_space_MiB = self.scratch_free_MiB() 465 | if free_space_MiB < self.settings.scratch_free_needed_MiB: 466 | raise NotEnoughScratchSpace(self.settings.scratch_dir, 467 | self.settings.scratch_free_needed_MiB, 468 | free_space_MiB) 469 | 470 | def ensure_scratch(self): 471 | if os.path.exists(self.settings.scratch_dir): 472 | if not os.path.isdir(self.settings.scratch_dir): 473 | raise ScratchAlreadyExists() 474 | else: 475 | os.mkdir(self.settings.scratch_dir) 476 | for disc in range(1, self.settings.total_set_count + 1): 477 | os.mkdir(os.path.join(self.settings.scratch_dir, 478 | self.disc_dir(disc))) 479 | self.ensure_free_space() 480 | # this is the copy of this program that dar will run 481 | self._copy(self.progname, 482 | os.path.join(self.settings.scratch_dir, 483 | os.path.basename(self.progname))) 484 | 485 | def _par_filename(self, basename, min_number, max_number): 486 | parformat = "{{}}.{0}-{0}.par".format(self.settings.number_format) 487 | return parformat.format(basename, min_number, max_number) 488 | 489 | def make_redundancy_files(self, basename, dar_files, max_number): 490 | nslices = len(dar_files) 491 | if nslices == 0: 492 | raise ValueError('no dar slices for parchive to operate on') 493 | min_number = max_number - nslices + 1 494 | parfilename = self._par_filename(basename, min_number, max_number) 495 | self._run(*(['parchive', 496 | '-n{}'.format(self.settings.parity_discs), 497 | 'a', parfilename, 498 | ] + dar_files)) 499 | return parfilename 500 | 501 | def burn(self, basename, slice_number, disc_in_set_number, dir, happening): 502 | if self.settings.actually_burn: 503 | self._run('growisofs', '-Z', self.settings.burner_device, 504 | '-R', '-J', '-V', 505 | self.disc_title_for_slice_and_disc(basename, slice_number, 506 | disc_in_set_number), 507 | dir) 508 | else: 509 | destination = os.path.join(self.settings.scratch_dir, 510 | self.disc_title_for_slice_and_disc(basename, slice_number, 511 | disc_in_set_number)) 512 | self.log.info('not actually burning: moving files from {} to ' \ 513 | '{}'.format(dir, destination)) 514 | os.mkdir(destination) 515 | for f in glob.glob(os.path.join(dir, '*')): 516 | shutil.move(f, os.path.join(destination, os.path.basename(f))) 517 | 518 | def _create(self, dir, basename, number, extension, happening): 519 | number = int(number) 520 | # note: dar has caused this function to be called; dar's cwd is 521 | # SCRATCH_DIR, hence so is ours 522 | dar_files_here = sorted(glob.glob('*.dar')) 523 | if len(dar_files_here) >= self.settings.data_discs or \ 524 | happening == 'last_slice': 525 | parfilename = self.make_redundancy_files( 526 | basename, dar_files_here, number) 527 | par_volumes = [f for f in os.listdir() 528 | if parity_volume_re.match(f)] 529 | for d in self.disc_dirs(): 530 | self._copy(parfilename, os.path.join(d, parfilename)) 531 | with io.open(os.path.join(d, 'README.txt'), 'wt') as readme: 532 | readme.write(self.readme(basename)) 533 | this_program = os.path.basename(self.progname) 534 | self._copy(this_program, os.path.join(d, this_program)) 535 | data_dirs = itertools.cycle(self.disc_dir(i+1) 536 | for i in range(self.settings.data_discs)) 537 | redundancy_dirs = itertools.cycle(self.disc_dir(i+1) 538 | for i in range(self.settings.data_discs, 539 | self.settings.total_set_count)) 540 | for f, d in itertools.chain( 541 | zip(dar_files_here, data_dirs), 542 | zip(par_volumes, redundancy_dirs)): 543 | shutil.move(f, d) 544 | dars_on_discs = len(glob.glob( 545 | os.path.join(self.disc_dir(1), '*.dar'))) 546 | size_if_we_dont_burn_KiB = (dars_on_discs + 1) * \ 547 | self.settings.slice_size_KiB + \ 548 | self.settings.reserve_space_KiB 549 | if size_if_we_dont_burn_KiB > self.settings.disc_size_KiB or \ 550 | happening == 'last_slice': 551 | for i, d in enumerate(self.disc_dirs()): 552 | self.log.info("burning from {}".format(d)) 553 | self.wait_for_empty_disc() 554 | self.burn(basename, number, i, d, happening) 555 | for fn in glob.glob(os.path.join(d, '*')): 556 | os.unlink(fn) 557 | 558 | def _slice_name(self, basename, number, extension): 559 | return '{{}}.{{:0{}d}}.{{}}'.format(self.settings.digits).format( 560 | basename, number, extension) 561 | 562 | def _number_from_slice_name_ob(self, filename): 563 | return int(filename.split('.')[-2], 10) 564 | 565 | def _number_from_slice_name_zb(self, filename): 566 | return self._number_from_slice_name_ob(filename) - 1 567 | 568 | def _numbers_from_par_filename_ob(self, filename): 569 | # maybe.dots.here.XXXXX-YYYYY.par 570 | numbers = filename.split('.')[-2] 571 | first_s, last_s = numbers.split('-') 572 | first_ob = int(first_s, 10) 573 | last_ob = int(last_s, 10) 574 | return (first_ob, last_ob) 575 | 576 | def _numbers_from_par_filename_zb(self, filename): 577 | a, b = self._numbers_from_par_filename_ob(filename) 578 | return (a-1, b-1) 579 | 580 | def _last_parity_set_slices_zb(self, basename): 581 | # SIDE EFFECT: compels the insertion of the first disc in the 582 | # last set. 583 | # 584 | # Any disc in a set has all the pars from the set. The name of 585 | # the par file contains the slice numbers in the set. So WLOG 586 | # we ask for the first disc. 587 | disc_dir = self.last_set_directory(basename, 0) 588 | self.log.debug('first disc in last set is %r', disc_dir) 589 | last_par = sorted([x for x in os.listdir(disc_dir) 590 | if x.endswith('.par')])[-1] 591 | self.log.debug('last_par is %r', last_par) 592 | return self._numbers_from_par_filename_zb(last_par) 593 | 594 | def _fetch_some_slices(self, basename, first_slice_zb, last_slice_zb=None): 595 | self.log.debug('_fetch_some_slices(%r, %r)', first_slice_zb, last_slice_zb) 596 | # we need entire parity sets, so if first_slice_zb is in the 597 | # middle of a set, we start at the beginning of the set 598 | first_slice_zb -= first_slice_zb % self.settings.data_discs 599 | set_number_zb = math.floor(first_slice_zb / 600 | self.settings.slices_per_set) 601 | self.log.debug('for slice %r (zb) et seq we want set (zb) %d', 602 | first_slice_zb, set_number_zb) 603 | # MAYBE FIXME: we take the set of .par files on the first disc 604 | # of the set as authoritative; if any are missing I'm not sure 605 | # what would happen. 606 | disc_zb = 0 607 | disc_title = self.disc_title(basename, set_number_zb, disc_zb) 608 | disc_dir = self.written_disc_directory(disc_title) 609 | pars = sorted([x for x in os.listdir(disc_dir) if x.endswith('.par')]) 610 | self.log.debug('pars: %r', pars) 611 | parity_set_ranges = [self._numbers_from_par_filename_zb(p) for p in pars] 612 | parity_sets_hereafter = [(a,b) for a,b in parity_set_ranges 613 | if a >= first_slice_zb] 614 | pars_hereafter = [self._par_filename(basename, a+1, b+1) 615 | for a,b in parity_sets_hereafter] 616 | self.log.debug('pars_hereafter (after slice %d, %d in set %d): %r', 617 | first_slice_zb, 618 | first_slice_zb % self.settings.slices_per_set, 619 | set_number_zb, 620 | pars_hereafter) 621 | if last_slice_zb is None: 622 | max_last_slice_zb = parity_sets_hereafter[-1][-1] 623 | if (max_last_slice_zb - first_slice_zb) < ( 624 | 0.5 * self.settings.slices_per_set): 625 | # no use being smart 626 | self.log.debug('less than half a set left, fetching the rest') 627 | last_slice_zb = max_last_slice_zb 628 | else: 629 | try: 630 | with open(os.path.join(self.settings.scratch_dir, 631 | 'last_fetched_fraction.txt')) as f: 632 | last_fetched_set_zb = int(f.readline()) 633 | last_fetched_fraction = float(f.readline()) 634 | except FileNotFoundError: 635 | last_fetched_set_zb = set_number_zb 636 | last_fetched_fraction = 0.03 637 | if last_fetched_set_zb != set_number_zb: 638 | # this file is out of date 639 | last_fetched_set_zb = set_number_zb 640 | last_fetched_fraction = 0.03 641 | to_fetch_fraction = last_fetched_fraction * 3 642 | self.log.debug('this time we are fetching %6.3f of a set', 643 | to_fetch_fraction) 644 | max_to_fetch = int((to_fetch_fraction * 645 | self.settings.slices_per_set) + 1) 646 | last_slice_zb = min(max_last_slice_zb, 647 | first_slice_zb + max_to_fetch) 648 | with open(os.path.join(self.settings.scratch_dir, 649 | 'last_fetched_fraction.txt'), 'wt') as f: 650 | print(last_fetched_set_zb, file=f) 651 | print(to_fetch_fraction, file=f) 652 | # we need entire parity sets, so if last_slice_zb is in the 653 | # middle of a set, we end at the end of the set 654 | for a, b in parity_sets_hereafter: 655 | if last_slice_zb >= a and last_slice_zb <= b: 656 | last_slice_zb = b 657 | break 658 | else: 659 | self.log.error('could not find which parity set slice %d is in', 660 | last_slice_zb) 661 | self.log.debug('last_slice_zb is %d', last_slice_zb) 662 | for disc_zb in range(self.settings.total_set_count): 663 | disc_title = self.disc_title(basename, set_number_zb, disc_zb) 664 | disc_dir = self.written_disc_directory(disc_title) 665 | for f in os.listdir(disc_dir): 666 | if f.endswith('.dar'): 667 | n = self._number_from_slice_name_zb(f) 668 | if n >= first_slice_zb and n <= last_slice_zb: 669 | self._copy(os.path.join(disc_dir, f), 670 | os.path.join(self.settings.scratch_dir, f)) 671 | elif parity_volume_re.match(f): 672 | a, b = self._numbers_from_par_filename_zb(f) 673 | if a >= first_slice_zb and b <= last_slice_zb: 674 | self._copy(os.path.join(disc_dir, f), 675 | os.path.join(self.settings.scratch_dir, f)) 676 | elif f.endswith('.par'): 677 | if f in pars_hereafter: 678 | self._copy(os.path.join(disc_dir, f), 679 | os.path.join(self.settings.scratch_dir, f)) 680 | for (a,b), parfilename in zip(parity_sets_hereafter, pars_hereafter): 681 | if a >= first_slice_zb and b <= last_slice_zb: 682 | self._run('parchive', 'r', parfilename) 683 | 684 | def _extract(self, dir, basename, number, extension, happening): 685 | number = int(number) 686 | if number == 0: 687 | # dar wants the last slice but doesn't know its number 688 | self._fetch_some_slices(basename, 689 | *self._last_parity_set_slices_zb(basename)) 690 | else: 691 | slice_name = self._slice_name(basename, number, extension) 692 | if os.path.exists(slice_name): 693 | # the first time this gets called with a real number, 694 | # happening is still 'init' so the hawkeyed will see 695 | # one of these messages before we go back to set 1 696 | self.log.debug('the file for slice (ob) %s already exists', 697 | number) 698 | return 699 | else: 700 | self._fetch_some_slices(basename, number) 701 | 702 | _list = _extract 703 | 704 | 705 | class TestDigits(unittest.TestCase): 706 | def test1(self): 707 | self.settings = Settings() 708 | self.settings.expected_data_size = 540.0 709 | self.settings.slices_per_disc = 500 710 | self.settings.disc_size = 23841 711 | # around 12,000 total slices 712 | self.assertEqual(self.settings.digits, 6) 713 | 714 | class UsesTempScratchDir(unittest.TestCase): 715 | def setUp(self): 716 | self.settings = Settings() 717 | tempdir = tempfile.mkdtemp('darbrrb_test') 718 | self.old_tempfile_tempdir = tempfile.tempdir 719 | tempfile.tempdir = tempdir 720 | self.settings.scratch_dir = tempdir 721 | self.log = logging.getLogger('test code') 722 | self.dars_created = [] 723 | self.par_pxx_files_created = [] 724 | 725 | def tearDown(self): 726 | shutil.rmtree(self.settings.scratch_dir) 727 | tempfile.tempdir = self.old_tempfile_tempdir 728 | 729 | def mkdirp_parents(self, *names): 730 | for name in names: 731 | dir, file = os.path.split(name) 732 | where = self.settings.scratch_dir 733 | for d in dir.split(os.path.sep): 734 | new = os.path.join(where, d) 735 | if not os.path.exists(new): 736 | os.mkdir(new) 737 | where = new 738 | 739 | def touch(self, *filenames): 740 | self.mkdirp_parents(*filenames) 741 | for name in filenames: 742 | with open(name, 'wt') as f: 743 | print('*', file=f) 744 | 745 | def mkdirp(self, *dirnames): 746 | self.mkdirp_parents(*dirnames) 747 | for name in dirnames: 748 | if not os.path.exists(name): 749 | os.mkdir(name) 750 | 751 | @property 752 | def dar_filename_format(self): 753 | return '{{}}.{}.dar'.format(self.settings.number_format) 754 | 755 | def touch_dar_file(self, basename, n): 756 | filename = self.dar_filename_format.format(basename,n) 757 | self.dars_created.append(filename) 758 | self.touch(filename) 759 | 760 | def touch_dar_files(self, basename, min, max): 761 | self.touch(*(self.dar_filename_format.format(basename,n) 762 | for n in range(min, max+1))) 763 | 764 | def touch_dar_file_in_output_dir(self, dir, basename, n): 765 | filename = self.dar_filename_format.format(basename, n) 766 | self.touch(os.path.join(dir, filename)) 767 | 768 | @property 769 | def par_main_format(self): 770 | return '{{}}.{0}-{0}.par'.format(self.settings.number_format) 771 | 772 | @property 773 | def par_volume_format(self): 774 | return '{{}}.{0}-{0}.{{}}{{:02d}}'.format(self.settings.number_format) 775 | 776 | def par_volume_names(self, basename, min_, max_, count): 777 | possible_volume_letters = 'pqrstuvxwyz' 778 | for i in range(count): 779 | # name.p00, name.p01, ..., name.p99, name.q00, ... 780 | letter = possible_volume_letters[i // 100] 781 | number = i % 100 782 | pfn = self.par_volume_format.format(basename, min_, max_, 783 | letter, number) 784 | yield pfn 785 | 786 | def touch_par_files(self, basename, min_, max_, count): 787 | self.touch(self.par_main_format.format(basename, min_, max_)) 788 | for pfn in self.par_volume_names(basename, min_, max_, count): 789 | self.par_pxx_files_created.append(pfn) 790 | self.touch(pfn) 791 | 792 | def touch_par_file_in_output_dir(self, dir, basename, min_, max_): 793 | fn = os.path.join(dir, 794 | self.par_main_format.format(basename, min_, max_)) 795 | #self.log.debug('touching %r', fn) 796 | self.touch(fn) 797 | 798 | 799 | 800 | 801 | class TestWorkingDirectoryContextManager(unittest.TestCase): 802 | @patch('os.chdir') 803 | @patch('os.getcwd', return_value='/zart') 804 | def testWorkingDirectory(self, getcwd, chdir): 805 | with working_directory('/fnord'): 806 | pass 807 | chdir.assert_has_calls([call('/fnord'), 808 | call('/zart')]) 809 | 810 | 811 | @patch('os.chdir') 812 | @patch('os.getcwd', return_value='/zart') 813 | @patch.object(Darbrrb, '_run') 814 | class TestInvokeDar(UsesTempScratchDir): 815 | def setUp(self): 816 | super().setUp() 817 | self.d = Darbrrb(self.settings, __file__) 818 | 819 | def testInvokeDar(self, _run, getcwd, chdir): 820 | self.d.dar('-c', 'basename', '-R', '/home/bla/photos') 821 | self.d._run.assert_called_with( 822 | 'dar', '-c', 'basename', '-R', '/home/bla/photos', 823 | '-B', os.path.join(self.settings.scratch_dir, 'darrc')) 824 | 825 | def testCurrentWorkingDirectory(self, _run, getcwd, chdir): 826 | self.d.dar('-c', 'basename', '-R', '/home/bla/photos') 827 | # we can only assume the chdir calls surround the _run 828 | chdir.assert_has_calls([ 829 | call(self.settings.scratch_dir), 830 | call('/zart')]) 831 | 832 | 833 | @patch.object(Darbrrb, '_run') 834 | @patch.object(Darbrrb, 'wait_for_empty_disc') 835 | class TestDarbrrbFourPlusOne(UsesTempScratchDir): 836 | data_discs = 4 837 | parity_discs = 1 838 | slices_per_disc = 5 839 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 840 | 841 | def setUp(self): 842 | super().setUp() 843 | self.settings.data_discs = self.data_discs 844 | self.settings.parity_discs = self.parity_discs 845 | self.settings.slices_per_disc = self.slices_per_disc 846 | self.settings.digits = 4 847 | self.settings.burner_device = '/dev/zero' 848 | # in our tests, _create is called, as though dar were invoking this 849 | # script; when dar does that, it's with the scratch dir as the cwd, 850 | # as tested above 851 | with patch.object(Darbrrb, 'scratch_free_MiB', 852 | return_value=self.pretend_free_space_MiB): 853 | self.d = Darbrrb(self.settings, __file__) 854 | self.d.ensure_scratch() 855 | self.cwd = os.getcwd() 856 | os.chdir(self.settings.scratch_dir) 857 | 858 | def tearDown(self): 859 | super().tearDown() 860 | os.chdir(self.cwd) 861 | 862 | def testFirstFileOfSet(self, wfed, _run): 863 | self.touch_dar_files('thing', 1,1) 864 | everything = list(os.walk(self.settings.scratch_dir)) 865 | self.d._create('dir', 'thing', '1', 'dar', 'operating') 866 | everything2 = list(os.walk(self.settings.scratch_dir)) 867 | self.assertEqual(everything, everything2) 868 | 869 | def testLastFileOfSet(self, wfed, _run): 870 | self.touch_dar_files('thing', 1,4) 871 | self.touch_par_files('thing', 1,4,1) 872 | self.d._create('dir', 'thing', '4', 'dar', 'operating') 873 | self.d._run.assert_any_call( 874 | 'parchive', '-n1', 'a', 875 | 'thing.0001-0004.par', 876 | 'thing.0001.dar', 'thing.0002.dar', 877 | 'thing.0003.dar', 'thing.0004.dar') 878 | self.assertEqual(self.d._run.call_count, 1) 879 | self.assertEqual(glob.glob('*.dar'), []) 880 | 881 | # the last set, our discs may not be full, but because we stripe files 882 | # across the whole set, they are likely all non-empty. 883 | def testLastDiscOfBackupNotEven(self, wfed, _run): 884 | self.touch_dar_files('thing', 13, 14) 885 | self.touch_par_files('thing', 13, 14, 1) 886 | self.d._create('dir', 'thing', '14', 'dar', 'last_slice') 887 | self.d._run.assert_any_call( 888 | 'parchive', '-n1', 'a', 889 | 'thing.0013-0014.par', 890 | 'thing.0013.dar', 'thing.0014.dar') 891 | self.d._run.assert_has_calls([ 892 | call('growisofs', '-Z', '/dev/zero', '-R', '-J', 893 | '-V', 'thing-0001-001', '__disc0001'), 894 | call('growisofs', '-Z', '/dev/zero', '-R', '-J', 895 | '-V', 'thing-0001-002', '__disc0002'), 896 | call('growisofs', '-Z', '/dev/zero', '-R', '-J', 897 | '-V', 'thing-0001-003', '__disc0003'), 898 | call('growisofs', '-Z', '/dev/zero', '-R', '-J', 899 | '-V', 'thing-0001-004', '__disc0004'), 900 | call('growisofs', '-Z', '/dev/zero', '-R', '-J', 901 | '-V', 'thing-0001-005', '__disc0005'), 902 | ]) 903 | self.assertEqual(self.d._run.call_count, 6) 904 | 905 | class TestDiscTitle(unittest.TestCase): 906 | def setUp(self): 907 | self.settings = Settings() 908 | self.settings.digits = 4 909 | self.d = Darbrrb(self.settings, __file__) 910 | self.log = logging.getLogger(self.__class__.__name__) 911 | 912 | def testQuickCheck(self): 913 | passes = 0 914 | fails = 0 915 | tries = 100 916 | for qc in range(tries): 917 | self.settings.data_discs = random.randint(1,40) 918 | self.settings.parity_discs = random.randint(1,40) 919 | self.settings.slices_per_disc = random.randint(1,100) 920 | sps = self.settings.slices_per_set 921 | complete_sets = random.randint(1,10) 922 | slices_in_last_set = random.randint(1,self.settings.slices_per_disc) 923 | calls = [] 924 | # sets are numbered starting with 1 925 | for set in range(1,complete_sets+1): 926 | calls.append((set, (set * sps), 'operating')) 927 | calls.append((set+1, ((set * sps) + 928 | random.randint(1, sps)), 929 | 'last_slice')) 930 | for set, slice, happening in calls: 931 | for disc in range(self.settings.total_set_count): 932 | should_name = 'fnord-%04d-%03d' % (set, disc+1) 933 | is_name = self.d.disc_title_for_slice_and_disc('fnord', slice, disc) 934 | self.assertEqual(is_name, should_name, 935 | 'with {s.data_discs} data discs, ' \ 936 | '{s.slices_per_disc} slices per disc, ' \ 937 | '{cs} complete sets, {sils} slices in last set, ' \ 938 | 'on set {set}, slice {slice}, ' \ 939 | 'happening {happening}, calls was {calls}, ' \ 940 | 'disc title should be ' \ 941 | '{should_name}, but is {is_name}'.format( 942 | s=self.settings, 943 | cs=complete_sets, sils=slices_in_last_set, 944 | set=set, slice=slice, happening=happening, 945 | calls=calls, 946 | should_name=should_name, is_name=is_name)) 947 | 948 | def testFourPlusOne(self): 949 | self.settings.data_discs = 4 950 | self.settings.parity_discs = 1 951 | self.settings.slices_per_disc = 11 952 | for set, slice, happening in ( 953 | (1, 44, 'operating'), 954 | (2, 88, 'operating'), 955 | (3, 100, 'last_slice')): 956 | for disc in range(self.settings.total_set_count): 957 | should_name = 'fnord-%04d-%03d' % (set, disc + 1) 958 | is_name = self.d.disc_title_for_slice_and_disc('fnord', slice, disc) 959 | 960 | def testThreePlusEight(self): 961 | self.settings.data_discs = 3 962 | self.settings.parity_discs = 8 963 | self.settings.slices_per_disc = 20 964 | for set, slice, happening in ((1, 60, 'operating'), (2, 98, 'last_slice')): 965 | for disc in range(self.settings.total_set_count): 966 | should_name = 'fnord-%04d-%03d' % (set, disc + 1) 967 | is_name = self.d.disc_title_for_slice_and_disc('fnord', slice, disc) 968 | self.assertEqual(is_name, should_name) 969 | 970 | 971 | @patch.object(Darbrrb, '_run') 972 | @patch.object(Darbrrb, 'wait_for_empty_disc') 973 | class TestWholeBackup(UsesTempScratchDir): 974 | data_discs = 4 975 | parity_discs = 1 976 | slices_per_disc = 5 977 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 978 | 979 | def setUp(self): 980 | super().setUp() 981 | self.log = logging.getLogger('test code') 982 | self.settings.data_discs = self.data_discs 983 | self.settings.parity_discs = self.parity_discs 984 | self.settings.slices_per_disc = self.slices_per_disc 985 | # all tests not written with a small disc size expect a large one. 986 | self.settings.disc_size_MiB = getattr(self, 'disc_size_MiB', 23841) 987 | self.settings.burner_device = '/dev/zero' 988 | # in our tests, _create is called, as though dar were invoking this 989 | # script; when dar does that, it's with the scratch dir as the cwd, 990 | # as tested above 991 | with patch.object(Darbrrb, 'scratch_free_MiB', 992 | return_value=self.pretend_free_space_MiB): 993 | self.d = Darbrrb(self.settings, __file__) 994 | self.d.ensure_scratch() 995 | self.cwd = os.getcwd() 996 | os.chdir(self.settings.scratch_dir) 997 | self.discs_burned = [] 998 | self.dar_create_slices_count = 0 # see test methods 999 | 1000 | def tearDown(self): 1001 | super().tearDown() 1002 | os.chdir(self.cwd) 1003 | 1004 | 1005 | def mock_dar(self, *args): 1006 | # set self.dar_create_slices_count before you run this method 1007 | # 1008 | # we assume here that dar is being called to create the archive 1009 | # args goes like dar -c basename -R root_of_files_to_save 1010 | dir = args[-1] 1011 | basename = args[2] 1012 | for slice in range(self.dar_create_slices_count-1): 1013 | # slice is zero-based but dar is one-based 1014 | self.touch_dar_file(basename, slice+1) 1015 | self.d._create(dir, basename, str(slice+1), 'dar', 'operating') 1016 | slice += 1 1017 | self.touch_dar_file(basename, slice+1) 1018 | self.d._create(dir, basename, str(slice+1), 'dar', 'last_slice') 1019 | 1020 | def mock_parchive(self, *args): 1021 | # expected args: parchive -n{} c outfile infile infile... 1022 | # -n is the number of redundancy files to make 1023 | # outfile is named {basename}.{slicemin}-{slicemax}.par 1024 | outfile = args[3] 1025 | nswitch = args[1] 1026 | bn, numbers, par = outfile.split('.') 1027 | n1, n2 = map(int, numbers.split('-')) 1028 | count = int(nswitch.lstrip('-n')) 1029 | self.touch_par_files(bn, n1, n2, count) 1030 | 1031 | def mock_growisofs(self, *args): 1032 | # expected args: growisofs .... dirname 1033 | files = list(map(os.path.basename, 1034 | sorted(glob.glob(os.path.join(args[-1], '*'))))) 1035 | # self.log.debug('burning disc with files {}'.format(files)) 1036 | self.discs_burned.append(files) 1037 | 1038 | def mock__run(self, *args): 1039 | # self.log.debug('args are %r', args) 1040 | if args[0] == 'dar': 1041 | self.mock_dar(*args) 1042 | elif args[0] == 'parchive': 1043 | self.mock_parchive(*args) 1044 | elif args[0] == 'growisofs': 1045 | self.mock_growisofs(*args) 1046 | else: 1047 | raise Exception('unknown command run under test', args) 1048 | 1049 | def testWholeBackup(self, wfed, _run): 1050 | dir = 'dir' 1051 | bn = 'whole' 1052 | sett = self.settings 1053 | complete_redundancy_sets = 2 1054 | _run.side_effect = self.mock__run 1055 | # two whole redundancy sets 1056 | # a couple of file sets, not enough to make a redundancy set 1057 | # a couple of odd files 1058 | self.dar_create_slices_count = \ 1059 | sett.slices_per_disc * sett.data_discs * \ 1060 | complete_redundancy_sets + \ 1061 | sett.slices_per_disc * sett.data_discs // 2 + \ 1062 | sett.data_discs // 2 1063 | # for each complete or partial (at end) set of {data_discs} dar files, 1064 | # we run parchive once 1065 | expected_pars_run = sett.slices_per_disc * \ 1066 | complete_redundancy_sets + \ 1067 | sett.slices_per_disc // 2 + \ 1068 | 1 1069 | # --- run code 1070 | self.d.dar('-c', bn, '-R', '/fnord') 1071 | max_slice = self.dar_create_slices_count 1072 | # --- assertions 1073 | #self.log.debug('calls:') 1074 | #for c in self.d._run.call_args_list: 1075 | # self.log.debug('%r', c) 1076 | def calls_running(executable): 1077 | return list(x for x in self.d._run.call_args_list 1078 | if x[0][0] == executable) 1079 | self.assertEqual(len(calls_running('parchive')), expected_pars_run) 1080 | expected_discs_burned = sett.total_set_count * ( 1081 | complete_redundancy_sets + 1) 1082 | self.assertEqual(len(calls_running('growisofs')), 1083 | expected_discs_burned) 1084 | unburned_dars = set(self.dars_created) 1085 | unburned_par_volumes = set(self.par_pxx_files_created) 1086 | for b in self.discs_burned: 1087 | unburned_dars -= set(b) 1088 | unburned_par_volumes -= set(b) 1089 | self.assertEqual(len(unburned_dars), 0) 1090 | # the last redundancy set will be incomplete 1091 | disc = 0 1092 | for redundancy_set in range(complete_redundancy_sets + 1): 1093 | for disc_in_set in range(sett.total_set_count): 1094 | b = self.discs_burned[disc] 1095 | self.assertTrue('README.txt' in b) 1096 | this_script = os.path.basename(__file__) 1097 | self.log.debug('__file__ is %s', this_script) 1098 | # this will likely be darbrrb.py - but it isn't 1099 | # certain. see when self.d gets created above 1100 | self.assertTrue(this_script in b) 1101 | dars_on_b = [x for x in b if x.endswith('.dar')] 1102 | # the code uses regexes; let's use a different way 1103 | # here in the test for thoroughness 1104 | par_volumes_on_b = [x for x in b 1105 | if x[-4] == '.' and x[-3] in 'pqr' 1106 | and x[-2] in '0123456789' 1107 | and x[-1] in '0123456789'] 1108 | par_files_on_b = [x for x in b if x.endswith('.par')] 1109 | if disc_in_set < sett.data_discs: 1110 | self.assertEqual(len(par_volumes_on_b), 0) 1111 | self.assertGreater(len(dars_on_b), 0) 1112 | self.assertGreater(len(par_files_on_b), 0) 1113 | else: 1114 | self.assertEqual(len(dars_on_b), 0) 1115 | self.assertGreater(len(par_volumes_on_b), 0) 1116 | self.assertGreater(len(par_files_on_b), 0) 1117 | if redundancy_set < complete_redundancy_sets: 1118 | # not the last set; should have not only some 1119 | # files, but a full complement of them 1120 | if disc_in_set < sett.data_discs: 1121 | self.assertEqual(len(par_files_on_b), sett.slices_per_disc) 1122 | self.assertEqual(len(dars_on_b), sett.slices_per_disc) 1123 | else: 1124 | self.assertEqual(len(par_files_on_b), sett.slices_per_disc) 1125 | self.assertEqual(len(par_volumes_on_b), sett.slices_per_disc) 1126 | disc += 1 1127 | 1128 | 1129 | # the decorators above have made it so that TestWholeBackup is decorated. when 1130 | # we derive from it here, our ThreePlusEight class is already decorated; so we 1131 | # needn't (and mustn't) write the decorators again. 1132 | class TestWholeBackupThreePlusEight(TestWholeBackup): 1133 | data_discs = 3 1134 | parity_discs = 8 1135 | slices_per_disc = 13 1136 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1137 | 1138 | # This is just to make sure all those integer divisions and multiplications 1139 | # aren't just happening to be right. 1140 | class TestWholeBackupNineteenPlusSeven(TestWholeBackup): 1141 | data_discs = 19 1142 | parity_discs = 7 1143 | slices_per_disc = 31 1144 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1145 | 1146 | # Really small discs are useful for manual testing, where we want to 1147 | # get an idea of how fast things will run or something, but don't want 1148 | # to waste a lot of space or time doing so at scale. 1149 | class TestReallySmallDiscs(TestWholeBackup): 1150 | data_discs = 3 1151 | parity_discs = 2 1152 | slices_per_disc = 50 1153 | pretend_free_space = (data_discs + parity_discs) * 25000 1154 | disc_size_MiB = 30 1155 | 1156 | 1157 | 1158 | 1159 | 1160 | 1161 | @patch.object(Darbrrb, '_run') 1162 | @patch.object(Darbrrb, '_copy') 1163 | class TestWholeRestore(UsesTempScratchDir): 1164 | data_discs = 4 1165 | parity_discs = 1 1166 | slices_per_disc = 5 1167 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1168 | 1169 | def setUp(self): 1170 | super().setUp() 1171 | self.log = logging.getLogger('test code') 1172 | self.settings.data_discs = self.data_discs 1173 | self.settings.parity_discs = self.parity_discs 1174 | self.settings.slices_per_disc = self.slices_per_disc 1175 | self.settings.actually_burn = False 1176 | # all tests not written with a small disc size expect a large one. 1177 | self.settings.disc_size_MiB = getattr(self, 'disc_size_MiB', 23841) 1178 | self.settings.burner_device = '/dev/zero' 1179 | # in our tests, _create is called, as though dar were invoking this 1180 | # script; when dar does that, it's with the scratch dir as the cwd, 1181 | # as tested above 1182 | with patch.object(Darbrrb, 'scratch_free_MiB', 1183 | return_value=self.pretend_free_space_MiB): 1184 | self.d = Darbrrb(self.settings, __file__) 1185 | self.d.ensure_scratch() 1186 | self.cwd = os.getcwd() 1187 | os.chdir(self.settings.scratch_dir) 1188 | from hashlib import sha256 1189 | self.basename = sha256(bytes(self.__class__.__name__, 'ascii')).hexdigest()[:8] 1190 | self.discs_consumed = [] 1191 | self.complete_redundancy_sets = 2 1192 | # two whole redundancy sets 1193 | # a couple of file sets, not enough to make a redundancy set 1194 | # a couple of odd files 1195 | sett = self.settings 1196 | self.dar_consume_slices_count = \ 1197 | sett.slices_per_disc * sett.data_discs * \ 1198 | self.complete_redundancy_sets + \ 1199 | sett.slices_per_disc * sett.data_discs // 2 + \ 1200 | sett.data_discs // 2 1201 | self.log.debug('dar_consume_slices_count is %d', 1202 | self.dar_consume_slices_count) 1203 | # BWAHAHAHAA this painful thing is so the main code and the 1204 | # test will be coded differently. 1205 | data_set_and_disc_zb = itertools.chain( 1206 | # complete sets 1207 | itertools.chain.from_iterable( 1208 | itertools.islice(zip(itertools.repeat(setno), 1209 | itertools.cycle(range(sett.data_discs))), 1210 | sett.slices_per_disc * sett.data_discs) 1211 | for setno in range(self.complete_redundancy_sets)), 1212 | # now the last set 1213 | itertools.chain.from_iterable( 1214 | itertools.islice(zip(itertools.repeat(setno), 1215 | itertools.cycle(range(sett.data_discs))), 1216 | (sett.slices_per_disc * sett.data_discs // 2 + 1217 | sett.data_discs // 2)) 1218 | for setno in range(self.complete_redundancy_sets, 1219 | self.complete_redundancy_sets+1))) 1220 | data_set_and_disc_zb = list(data_set_and_disc_zb) 1221 | for slice_zb, (setno_zb, disc_zb) in zip( 1222 | range(self.dar_consume_slices_count), 1223 | data_set_and_disc_zb): 1224 | # disc_title gets tested above, so we'll just use it here 1225 | disc_title = self.d.disc_title(self.basename, setno_zb, disc_zb) 1226 | self.touch_dar_file_in_output_dir(disc_title, self.basename, 1227 | slice_zb+1) 1228 | # par files go on every data disc 1229 | self.touch_par_file_in_output_dir(disc_title, self.basename, 1230 | (slice_zb - disc_zb)+1, 1231 | min(((slice_zb - disc_zb)+1 + 1232 | self.data_discs-1), 1233 | self.dar_consume_slices_count)) 1234 | parity_set_and_disc_zb = itertools.chain( 1235 | # complete sets 1236 | itertools.chain.from_iterable( 1237 | itertools.islice(zip(itertools.repeat(setno), 1238 | itertools.cycle(range(sett.data_discs, 1239 | (sett.data_discs + 1240 | sett.parity_discs)))), 1241 | sett.slices_per_disc * sett.parity_discs) 1242 | for setno in range(self.complete_redundancy_sets+2))) 1243 | # now the last set 1244 | # itertools.chain.from_iterable( 1245 | # itertools.islice(zip(itertools.repeat(setno), 1246 | # itertools.cycle(range(sett.data_discs, 1247 | # (sett.data_discs + 1248 | # sett.parity_discs)))), 1249 | # (sett.slices_per_disc * sett.parity_discs // 2 + 1250 | # sett.parity_discs // 2)) 1251 | # for setno in range(self.complete_redundancy_sets, 1252 | # self.complete_redundancy_sets+1))) 1253 | parity_set_and_disc_zb = list(parity_set_and_disc_zb) 1254 | mins_and_maxes = itertools.chain.from_iterable( 1255 | map(itertools.repeat, zip( 1256 | range(0, self.dar_consume_slices_count, self.data_discs), 1257 | itertools.chain( 1258 | range(self.data_discs-1, self.dar_consume_slices_count, 1259 | self.data_discs), 1260 | itertools.repeat(self.dar_consume_slices_count-1))), 1261 | itertools.repeat(self.parity_discs))) 1262 | mins_and_maxes = list(mins_and_maxes) 1263 | for (min_zb, max_zb), (setno_zb, disc_zb) in zip( 1264 | mins_and_maxes, 1265 | parity_set_and_disc_zb): 1266 | disc_title = self.d.disc_title(self.basename, setno_zb, disc_zb) 1267 | self.touch_par_file_in_output_dir(disc_title, self.basename, 1268 | min_zb+1, max_zb+1) 1269 | # cheat: we don't touch the par volume files. only the real 1270 | # parchive actually needs them! 1271 | # os.system('bash') 1272 | 1273 | 1274 | 1275 | 1276 | def tearDown(self): 1277 | super().tearDown() 1278 | os.chdir(self.cwd) 1279 | 1280 | def mock_dar(self, *args): 1281 | # set self.dar_consume_slices_count before you run this method 1282 | # 1283 | # we assume here that dar is being called to extract the archive 1284 | # args goes like dar -x basename -R root_of_files_to_save 1285 | dir = args[-1] 1286 | basename = args[2] 1287 | # get last slice 1288 | self.d._extract(dir, basename, '0', 'dar', 'init') 1289 | self.d._extract(dir, basename, self.dar_consume_slices_count, 'dar', 'init') 1290 | for slice in range(self.dar_consume_slices_count): 1291 | # slice is zero-based but dar is one-based 1292 | self.d._extract(dir, basename, str(slice+1), 'dar', 'operating') 1293 | 1294 | def mock_parchive(self, *args): 1295 | # expected args: parchive r parfile 1296 | # parfile is named {basename}.{slicemin}-{slicemax}.par 1297 | parfile = args[2] 1298 | # put logic here in future to mock one or more of the files 1299 | # being invalid or missing 1300 | 1301 | def mock__run(self, *args): 1302 | self.log.debug('args are %r', args) 1303 | if args[0] == 'dar': 1304 | self.mock_dar(*args) 1305 | elif args[0] == 'parchive': 1306 | self.mock_parchive(*args) 1307 | else: 1308 | raise Exception('unknown command run under test', args) 1309 | 1310 | def testWholeRestore(self, _copy, _run): 1311 | dir = 'dir' 1312 | _run.side_effect = self.mock__run 1313 | _copy.side_effect = shutil.copyfile 1314 | # we run parchive once to get the last slice. then, 1315 | # 1316 | # for each complete or partial (at end) set of {data_discs} dar files, 1317 | # we run parchive once 1318 | sett = self.settings 1319 | expected_pars_run = (1 + 1320 | (sett.slices_per_disc * 1321 | self.complete_redundancy_sets) + 1322 | (sett.slices_per_disc // 2 + 1)) 1323 | # --- run code 1324 | self.d.dar('-x', self.basename, '-R', '/fnord') 1325 | # --- assertions 1326 | self.log.debug('calls:') 1327 | for c in self.d._run.call_args_list: 1328 | self.log.debug('%r', c) 1329 | def calls_running(executable): 1330 | return list(x for x in self.d._run.call_args_list 1331 | if x[0][0] == executable) 1332 | #self.log.debug(calls_running('parchive')) 1333 | unique_basenames_copied = sorted(list(set( 1334 | [os.path.basename(c[0][0]) for c in self.d._copy.call_args_list]))) 1335 | self.log.debug('unique basenames copied: %r', unique_basenames_copied) 1336 | self.assertEqual(len([b for b in unique_basenames_copied 1337 | if b.endswith('.par')]), 1338 | ((self.dar_consume_slices_count + 1339 | self.settings.data_discs-1) // 1340 | self.settings.data_discs), 1341 | 'unexpected number of pars copied') 1342 | self.assertEqual(len(calls_running('parchive')), expected_pars_run) 1343 | # not tested so far: 1344 | # * only the files for one set are in the scratch dir at once 1345 | 1346 | 1347 | class TestWholeRestoreThreePlusEight(TestWholeRestore): 1348 | data_discs = 3 1349 | parity_discs = 8 1350 | slices_per_disc = 13 1351 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1352 | 1353 | class TestWholeRestoreNineteenPlusSeven(TestWholeRestore): 1354 | data_discs = 19 1355 | parity_discs = 7 1356 | slices_per_disc = 31 1357 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1358 | 1359 | 1360 | 1361 | @patch.object(Darbrrb, '_run') 1362 | class TestPartialRestore(TestWholeRestore): 1363 | def setUp(self): 1364 | super().setUp() 1365 | # now, unlike the full restore, we will not ask for every 1366 | # slice. just some toward the end of the first set, and into 1367 | # the second set. 1368 | s = self.settings 1369 | # the first fetch will do 9% of the slices; make it fetch 1370 | # twice from the first set 1371 | self.first_slice_dar_requests = int(s.slices_per_set * (1 - 0.14)) 1372 | # and only once from the beginning of the second set 1373 | self.last_slice_dar_requests = int(s.slices_per_set * (1 + 0.08)) 1374 | 1375 | def mock_dar(self, *args): 1376 | # set self.dar_consume_slices_count before you run this method 1377 | # 1378 | # we assume here that dar is being called to extract the archive 1379 | # args goes like dar -x basename -R root_of_files_to_save 1380 | dir = args[-1] 1381 | basename = args[2] 1382 | # get last slice 1383 | self.d._extract(dir, basename, '0', 'dar', 'init') 1384 | self.d._extract(dir, basename, self.dar_consume_slices_count, 'dar', 'init') 1385 | for slice in range(self.first_slice_dar_requests, 1386 | self.last_slice_dar_requests + 1): 1387 | # slice is zero-based but dar is one-based 1388 | self.d._extract(dir, basename, str(slice+1), 'dar', 'operating') 1389 | 1390 | # we are testing a partial restore, but deriving from the whole 1391 | # restore class. if we do not call this method testWholeRestore, 1392 | # the superclass's test method will remain. 1393 | def testWholeRestore(self, _run): 1394 | dir = 'dir' 1395 | _run.side_effect = self.mock__run 1396 | # we run parchive once to get the last slice. then, 1397 | # 1398 | # for each complete or partial (at end) set of {data_discs} dar files, 1399 | # we run parchive once 1400 | sett = self.settings 1401 | fsdrzb = self.first_slice_dar_requests - 1 1402 | lsdrzb = self.last_slice_dar_requests - 1 1403 | first_slice_fetched_zb = fsdrzb - fsdrzb % sett.data_discs 1404 | # this simple math below only works because we are certainly 1405 | # not running into the last parity set; that set can be incomplete. 1406 | last_slice_fetched_zb = (lsdrzb - lsdrzb % sett.data_discs + 1407 | sett.data_discs - 1) 1408 | complete_parity_sets = (last_slice_fetched_zb + 1 - 1409 | first_slice_fetched_zb) // sett.data_discs 1410 | expected_pars_run = (1 + # for the last slice 1411 | complete_parity_sets) 1412 | # --- run code 1413 | self.d.dar('-x', self.basename, '-R', '/fnord', 'some-file') 1414 | # --- assertions 1415 | self.log.debug('calls:') 1416 | for c in self.d._run.call_args_list: 1417 | self.log.debug('%r', c) 1418 | def calls_running(executable): 1419 | return list(x for x in self.d._run.call_args_list 1420 | if x[0][0] == executable) 1421 | self.log.debug(calls_running('parchive')) 1422 | self.assertEqual(len(calls_running('parchive')), expected_pars_run) 1423 | # not tested so far: 1424 | # * only the files for one set are in the scratch dir at once 1425 | 1426 | class TestPartialRestoreThreePlusEight(TestPartialRestore): 1427 | data_discs = 3 1428 | parity_discs = 8 1429 | slices_per_disc = 13 1430 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1431 | 1432 | class TestPartialRestoreNineteenPlusSeven(TestPartialRestore): 1433 | data_discs = 19 1434 | parity_discs = 7 1435 | slices_per_disc = 31 1436 | pretend_free_space_MiB = (data_discs + parity_discs) * 25000 1437 | 1438 | 1439 | 1440 | if __name__ == '__main__': 1441 | s = Settings() 1442 | if len(sys.argv) < 2: 1443 | usage(s) 1444 | sys.exit(1) 1445 | opts, remaining = getopt.getopt(sys.argv[1:], 'hvnt', ['help']) 1446 | loglevel = logging.WARNING 1447 | testing = False 1448 | for o, v in opts: 1449 | if o == '-h' or o == '--help': 1450 | usage(s) 1451 | sys.exit(1) 1452 | elif o == '-v': 1453 | loglevel -= 10 1454 | elif o == '-n': 1455 | s.actually_burn = False 1456 | # warn user 1457 | from time import sleep 1458 | for i in range(25): 1459 | for j in range(4): 1460 | print('not actually burning', end=' * ') 1461 | print('\n') 1462 | sleep(5) 1463 | elif o == '-t': 1464 | loglevel = logging.DEBUG 1465 | testing = True 1466 | else: 1467 | raise Exception('unknown switch {}'.format(o)) 1468 | # style only influences how format is interpreted, not also how values are 1469 | # interpolated into log messages. source: Python 3.2 1470 | # logging/__init__.py:317, LogRecord class, getMessage method. 1471 | fmt = logging.Formatter(style='{', fmt='darbrrb {process} ' 1472 | '[{asctime}] {name}: {message}') 1473 | stream = logging.StreamHandler(sys.stderr) 1474 | stream.setFormatter(fmt) 1475 | root_logger = logging.getLogger() 1476 | root_logger.addHandler(stream) 1477 | root_logger.setLevel(loglevel) 1478 | # dar expects its stdin and stdout to be a terminal so we will 1479 | # make a log file for our messages rather than depend on 1480 | # redirection 1481 | logfile = logging.FileHandler('darbrrb.log.{}'.format(os.getpid())) 1482 | logfile.setFormatter(fmt) 1483 | root_logger.addHandler(logfile) 1484 | log = logging.getLogger('__main__'.format(os.getpid())) 1485 | log.debug('called with args %r', sys.argv) 1486 | if testing: 1487 | # strip off switches: they are not for unittest.main 1488 | sys.argv = [sys.argv[0]] + remaining 1489 | sys.exit(unittest.main()) 1490 | d = Darbrrb(s, __file__, opts) 1491 | try: 1492 | if remaining[0] == 'dar': 1493 | os.environ['DARBRRB_ORIGINAL_ARGV'] = base64.b64encode( 1494 | pickle.dumps(sys.argv, protocol=0)).decode('UTF-8') 1495 | d.ensure_scratch() 1496 | d.dar(*remaining[1:]) 1497 | elif remaining[0] == '_create': 1498 | d._create(*remaining[1:]) 1499 | elif remaining[0] == '_extract': 1500 | d._extract(*remaining[1:]) 1501 | elif remaining[0] == '_list': 1502 | d._list(*remaining[1:]) 1503 | else: 1504 | raise Exception("unknown subcommand", remaining) 1505 | log.debug('execution ended without exception') 1506 | except Exception as e: 1507 | log.exception('execution ended abnormally') 1508 | raise 1509 | --------------------------------------------------------------------------------