├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.rst ├── autopkg-recipe ├── PythonBDistBuilder.py └── git2jss.pkg.recipe ├── azure-pipelines.yml ├── git2jss ├── __init__.py ├── exceptions.py ├── jss_keyring.py ├── processors.py └── vcs.py ├── release.sh ├── requirements.txt ├── setup.cfg ├── setup.py └── tests ├── conftest.py ├── test_git2jss.py ├── test_processors.py └── test_vcs.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # pycharm 7 | .idea/ 8 | .idea 9 | 10 | # Packages 11 | *.egg 12 | *.egg-info 13 | .eggs/ 14 | build 15 | eggs 16 | parts 17 | var 18 | sdist 19 | develop-eggs 20 | .installed.cfg 21 | lib 22 | lib64 23 | 24 | # Installer logs 25 | pip-log.txt 26 | 27 | # Unit test / coverage reports 28 | .coverage 29 | .tox 30 | nosetests.xml 31 | .pytest_cache/ 32 | 33 | # Complexity 34 | output/*.html 35 | output/*/index.html 36 | 37 | # Sphinx 38 | docs/_build 39 | 40 | # Cookiecutter 41 | output/ 42 | 43 | # MacOS 44 | .DS_Store 45 | *~ 46 | 47 | #setuptools 48 | .cache/ 49 | dist/ 50 | 51 | # Just there for testing 52 | com.github.gkluoe.git2jss.plist 53 | _jss 54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include requirements.txt -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. image:: https://dev.azure.com/gklee/git2jss/_apis/build/status/gkluoe.git2jss?branchName=master 2 | 3 | Git2JSS 4 | =============================== 5 | 6 | Version : v2.0.1 7 | 8 | Author: Geoff Lee 9 | 10 | Overview 11 | -------- 12 | **Question:** *How do you ensure that all changes to Scripts and ComputerExtensionAttributes in your JAMF JSS are logged, reversible, and match what you have in source control?* 13 | 14 | **Answer:** *Make it zero-effort.* 15 | 16 | Using *Git2jss*, after making changes to JSS Scripts or CEAs in your dev/test environment and pushing them to a Git repository, you can export a tagged copy to your JSS, complete with the Git changelog in the 'Notes' field. Reverting a change is as easy as exporting the previous tagged version. 17 | 18 | You can also use this script in a Continuous Integration pipeline to export scripts from the head of a given branch to your JSS. 19 | 20 | Templating of some important values is also supported, so your scripts automatically contain details of the last change, and where they can be found in source control. 21 | 22 | Passwords are stored in the system keychain by default. 23 | 24 | Installation / Usage 25 | -------------------- 26 | 27 | NB: the ``python-jss`` and ``keyring`` modules are required. If manually installing, you'll need to make sure they are present. 28 | Installing via pip should take care of this for you. 29 | 30 | Install via pip 31 | ``````````````` 32 | 33 | If you're installing into a virtualenv 34 | 35 | ``$ pip install git2jss`` 36 | 37 | should be all you need to do. 38 | 39 | 40 | If installing onto OS X 10.13 and not using a virtualenv, 41 | you'll need to use sudo, and install a missing dependency: 42 | 43 | ``$ sudo pip install git2jss`` 44 | 45 | ``$ sudo pip install cryptography`` 46 | 47 | Or manually 48 | ```````````` 49 | 50 | Clone the repo and run the setup script 51 | 52 | ``$ git clone https://github.com/gkluoe/git2jss.git`` 53 | 54 | ``$ python setup.py install`` 55 | 56 | 57 | 58 | Examples 59 | -------- 60 | 61 | Commandline 62 | ``````````` 63 | 64 | You can use it on the commandine like this:: 65 | 66 | # Export the file localscript.sh to a Script object on the JSS called do_something_great.sh 67 | # using the existing tag v0.0.9 68 | 69 | $ git tag v0.0.9 && git push origin v0.0.9 70 | $ git2jss --file localscript.sh --name do_something_great.sh --tag v0.0.9 71 | 72 | # Export the file run-softwareupdate.py at the head of the master branch 73 | # to an object on the JSS with the same name 74 | 75 | $ git2jss --file run-softwareupdate.py --branch master 76 | 77 | # Export the file check_firewall.sh to a ComputerExtensionAttribute object on the JSS called 78 | # FirewallCheck, using the existing tag v0.0.9 79 | 80 | $ git2jss --mode ComputerExtensionAttribute --file check_firewall.sh --name check-firewall --tag v0.0.9 81 | 82 | # Export each script in the current folder that has a script object on the server 83 | # with a matching name, and exists at tag v1.0.2 84 | 85 | $ git2jss --all --tag v1.0.2 86 | 87 | # Or do the same for all files at the head of branch 'production' 88 | 89 | $ git2jss --all --branch production 90 | 91 | # Show information about the currently configured JSS (or enter details if none configured) 92 | 93 | $ git2jss --jss-info 94 | 95 | Templating 96 | `````````` 97 | 98 | The following variables, if embedded into your script, will be replaced with the indicated values when being transferred to the JSS 99 | 100 | +--------------+-------------------------------------------------------------------------------------------------+ 101 | | Variable | Value | 102 | +==============+=================================================================================================+ 103 | | ``@@VERSION``| If --tag was used: The name of the git tag that you have specified (eg v1.0.1) | 104 | | | If --branch was used: The commit hash of the last change of the file, and a note of the branch | 105 | +--------------+-------------------------------------------------------------------------------------------------+ 106 | | ``@@ORIGIN`` | Assuming you have a git remote called 'origin', the URL thereof | 107 | | | (eg https://github.com/uoe-macos/jss) | 108 | +--------------+-------------------------------------------------------------------------------------------------+ 109 | | ``@@PATH`` | The name of the file in the git repository identified by @@ORIGIN`` | 110 | +--------------+-------------------------------------------------------------------------------------------------+ 111 | | ``@@DATE`` | The date of the *last change* of the file in Git | 112 | +--------------+-------------------------------------------------------------------------------------------------+ 113 | | ``@@USER`` | The username used by git2jss to authenticate to the JSS at | 114 | | | the time the script was exported | 115 | +--------------+-------------------------------------------------------------------------------------------------+ 116 | | ``@@LOG`` | The entire Git log for this script, formatted thus: | 117 | | | ``'%h - %cD %ce: %n %s%n'`` | 118 | +--------------+-------------------------------------------------------------------------------------------------+ 119 | 120 | ``@@LOG`` is used to construct the 'Notes' field in the JSS, overwriting anything that was present previously. 121 | 122 | 123 | Contributing 124 | ------------ 125 | 126 | Issues and pull requests are very welcome! 127 | -------------------------------------------------------------------------------- /autopkg-recipe/PythonBDistBuilder.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 Geoff Lee 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | """Processor to build a python distutils project""" 15 | import os 16 | import shutil 17 | from zipfile import ZipFile 18 | from subprocess import check_call 19 | from pkg_resources import packaging 20 | # Pylint can't load autopkglib, so stop it moaning 21 | #pylint: disable=locally-disabled,import-error 22 | from autopkglib import Processor, ProcessorError 23 | 24 | 25 | __all__ = ["PythonBDistBuilder"] 26 | 27 | #pylint: disable=locally-disabled,too-few-public-methods 28 | class PythonBDistBuilder(Processor): 29 | """Build a python disttools project, ready for packaging""" 30 | description = __doc__ 31 | input_variables = { 32 | "source_path": { 33 | "required": True, 34 | "description": "Path to the source directory of the package.", 35 | }, 36 | } 37 | output_variables = { 38 | "bdist_root": { 39 | "description": "Root directory of the built distribution", 40 | }, 41 | } 42 | 43 | #pylint: disable= 44 | 45 | def main(self): 46 | """Build and then unzip the distribution""" 47 | try: 48 | os.chdir(self.env['source_path']) 49 | check_call(['/usr/bin/python', 'setup.py', 50 | 'bdist', '-p', 'macOS', '--formats', 'zip']) 51 | self.output("Built dist at %s" % self.env['source_path']) 52 | except BaseException, err: 53 | raise ProcessorError("Can't build dist at %s: %s" 54 | % (self.env['source_path'], err)) 55 | 56 | # Now, unzip the built distribution to give us a file hierarchy 57 | bdist_root = self.env['RECIPE_CACHE_DIR'] + '/bdist_root' 58 | # Make sure we have a clean target directory 59 | if os.path.isdir(bdist_root): 60 | shutil.rmtree(bdist_root) 61 | try: 62 | # The python packaging tools will 'normalise' the version number 63 | # - we need to do the same, or ours may not match. 64 | # This code is cribbed from the module that does it. 65 | # See setuptools/dist.py 66 | ver = packaging.version.Version(self.env['VERSION']) 67 | normalised_version = str(ver) 68 | if self.env['VERSION'] != normalised_version: 69 | self.output( 70 | "Normalising '%s' to '%s'" % ( 71 | self.env['VERSION'], 72 | normalised_version, 73 | ) 74 | ) 75 | zipped = ZipFile('./dist/' + self.env['NAME'] + 76 | '-' + normalised_version + '.macOS.zip') 77 | zipped.extractall(path=bdist_root) 78 | self.output("Unzipped built distribution root at %s" % bdist_root) 79 | self.env['bdist_root'] = bdist_root 80 | except BaseException, err: 81 | raise ProcessorError("Can't extract built distribution root at %s: %s" 82 | % (bdist_root, err)) 83 | 84 | if __name__ == '__main__': 85 | PROCESSOR = PythonBDistBuilder() 86 | PROCESSOR.execute_shell() 87 | -------------------------------------------------------------------------------- /autopkg-recipe/git2jss.pkg.recipe: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Description 6 | Downloads version the git2jss source and packages it 7 | Identifier 8 | com.github.gkluoe.pkg.git2jss 9 | Input 10 | 11 | NAME 12 | git2jss 13 | VERSION 14 | 2.0.0 15 | DOWNLOAD_URL 16 | https://github.com/gkluoe/git2jss/archive/v%VERSION%.zip 17 | 18 | MinimumVersion 19 | 0.2.0 20 | Process 21 | 22 | 23 | Processor 24 | URLDownloader 25 | Arguments 26 | 27 | url 28 | %DOWNLOAD_URL% 29 | filename 30 | %NAME%.zip 31 | 32 | 33 | 34 | Processor 35 | Unarchiver 36 | Arguments 37 | 38 | archive_path 39 | %pathname% 40 | destination_path 41 | %RECIPE_CACHE_DIR%/unzip 42 | purge_destination 43 | 44 | 45 | 46 | 47 | Processor 48 | PythonBDistBuilder 49 | Arguments 50 | 51 | source_path 52 | %RECIPE_CACHE_DIR%/unzip/%NAME%-%VERSION% 53 | 54 | 55 | 56 | Processor 57 | PkgCreator 58 | Arguments 59 | 60 | pkgname 61 | %NAME%-%VERSION% 62 | pkg_request 63 | 64 | pkgdir 65 | %RECIPE_CACHE_DIR% 66 | pkgroot 67 | %bdist_root% 68 | id 69 | com.github.gkluoe.pkg.git2jss 70 | version 71 | %VERSION% 72 | options 73 | purge_ds_store 74 | chown 75 | 76 | 77 | path 78 | Library 79 | user 80 | root 81 | group 82 | wheel 83 | 84 | 85 | path 86 | usr 87 | user 88 | root 89 | group 90 | wheel 91 | 92 | 93 | path 94 | usr/local/bin/%NAME% 95 | user 96 | root 97 | group 98 | wheel 99 | mode 100 | 0755 101 | 102 | 103 | 104 | 105 | 106 | 107 | Processor 108 | EndOfCheckPhase 109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /azure-pipelines.yml: -------------------------------------------------------------------------------- 1 | # Python package 2 | # Create and test a Python package on multiple Python versions. 3 | # Add steps that analyze code, save the dist with the build record, publish to a PyPI-compatible index, and more: 4 | # https://docs.microsoft.com/azure/devops/pipelines/languages/python 5 | 6 | trigger: 7 | - master 8 | 9 | jobs: 10 | 11 | - job: 'Test' 12 | pool: 13 | vmImage: 'macOS-10.13' 14 | strategy: 15 | matrix: 16 | Python27: 17 | python.version: '2.7' 18 | maxParallel: 4 19 | 20 | steps: 21 | - task: UsePythonVersion@0 22 | inputs: 23 | addToPath: true 24 | versionSpec: '$(python.version)' 25 | architecture: 'x64' 26 | 27 | - script: python -m pip install --upgrade pip && pip install -r requirements.txt 28 | displayName: 'Install dependencies' 29 | 30 | - script: pylint git2jss 31 | displayName: 'Lint' 32 | 33 | - script: | 34 | python setup.py test --addopts '-m "not need_jss"' 35 | displayName: 'Run tests that do not require access to a JSS' 36 | 37 | -------------------------------------------------------------------------------- /git2jss/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Copyright (C) 2019 Geoff Lee 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | """ git2jss: synchronise JSS scripts with a Git tag """ 18 | from __future__ import absolute_import, division, print_function 19 | import sys 20 | import subprocess 21 | import os 22 | import io 23 | import re 24 | import argparse 25 | import tempfile 26 | import shutil 27 | import xml 28 | from string import Template 29 | from base64 import b64encode 30 | import jss 31 | import git2jss.processors as processors 32 | from .jss_keyring import KJSSPrefs 33 | from .vcs import GitRepo 34 | from .exceptions import Git2JSSError 35 | 36 | 37 | 38 | DESCRIPTION = """A tool to update scripts on the JSS to match a tag or the head 39 | of a branch in a Git repository. 40 | 41 | The tool can push scripts from an existing tag or from the head of any branch 42 | 43 | The 'notes' field of the JSS script object will contain the Git log for the corresponding 44 | Script file. Some templating is also carried out. 45 | 46 | You need to have the jss-python module installed and configured appropriately to talk to your JSS. 47 | MANY thanks to sheagcraig for that module: https://github.com/sheagcraig/python-jss 48 | 49 | TEMPLATING: The following fields, if present in the script file, will be templated with values from Git 50 | 51 | @@DATE Date of last change 52 | @@VERSION The name of the TAG this file was pushed from, or the commit ID combined with BRANCH 53 | @@ORIGIN Origin URL from Git config 54 | @@PATH The path to the script file relative to the root of the Git repo 55 | @@USER JSS Username used to push the script (from jss-python configuration) 56 | 57 | """ 58 | 59 | 60 | EPILOG = """ 61 | """ 62 | 63 | VERSION = "2.0.0" 64 | 65 | # List of processors that we support - each is a class in the 66 | # `processors` module 67 | PROCESSORS = ['Script', 'ComputerExtensionAttribute'] 68 | 69 | def _get_args(argv=None): 70 | """ Parse arguments from the commandline and return an object containing them """ 71 | 72 | parser = argparse.ArgumentParser(usage=('git2jss [-v --version] [-i --jss-info] [-h] ' 73 | '[ --mode MODE ] [ --no-keychain ] ' 74 | '[ --prefs-file ] (--all | --file FILE ' 75 | '[ --name NAME ]) (--tag TAG | --branch BRANCH)'), 76 | description=DESCRIPTION, epilog=EPILOG, 77 | formatter_class=argparse.RawDescriptionHelpFormatter) 78 | 79 | parser.add_argument('-v', '--version', action='version', version=VERSION, 80 | help='Display the version and exit') 81 | 82 | parser.add_argument('-i', '--jss-info', action='store_true', dest='jss_info', 83 | help="Show information about the currently configured JSS") 84 | 85 | parser.add_argument('--tag', metavar='TAG', type=str, default=None, 86 | help=('Name of the tag on the git remote to operate from.' 87 | 'The tag must have been pushed to the remote: ' 88 | 'locally committed tags will not be accepted.')) 89 | 90 | parser.add_argument('--branch', metavar='BRANCH', type=str, default=None, 91 | help=('An branch on the git remote operate from.' 92 | 'eg: develop.' 93 | 'The head of the branch will be checked out and used as' 94 | 'the source for "--file"')) 95 | 96 | parser.add_argument('--mode', metavar='MODE', type=str, choices=PROCESSORS, 97 | dest='mode', default='Script', 98 | help=('Mode of operation. Use this option to operate on different types ' 99 | 'of JSS object. Currently supported values are: {}.\nDefaults to ' 100 | '"Script"' 101 | .format("\n".join(PROCESSORS)))) 102 | 103 | parser.add_argument('--name', metavar='NAME', dest='target_name', type=str, default=None, 104 | help=('Name of the target object in the JSS (if omitted, it is assumed ' 105 | 'that the target object has a name exactly matching FILE)')) 106 | 107 | parser.add_argument('--no-keychain', action='store_true', default=False, dest='no_keychain', 108 | help=('Do not store authentication credentials in the system keychain. ' 109 | 'Instead, store them IN PLAINTEXT in the preferences file.\n' 110 | 'Be careful with this option - it could be useful in CI/CD ' 111 | 'environments.')) 112 | 113 | parser.add_argument('--local-repo', metavar='LOCAL_REPO', dest='local_repo', type=str, 114 | default='.', 115 | help=('Path to the locally checked-out copy of the git repo you want ' 116 | 'to work on')) 117 | 118 | parser.add_argument('--prefs-file', metavar='PLIST', default=None, dest='prefs_file', 119 | help=(('Specify a preferences file to use. You can use this option' 120 | 'to talk to multiple separate JamfPro servers'))) 121 | 122 | file_or_all = parser.add_mutually_exclusive_group() 123 | 124 | file_or_all.add_argument('--file', metavar='FILE', dest='source_file', type=str, 125 | help='File in the Git repo containing the script to push to the JSS') 126 | 127 | file_or_all.add_argument('--all', action='store_true', default=False, dest='push_all', 128 | help=('Push every file in the Git repo for which there is an ' 129 | 'object with a matching name in the JSS.')) 130 | 131 | 132 | options = parser.parse_args(argv) 133 | 134 | # --name doesn't make any sense with --all, but argparse won't 135 | # let us express that with groups, so add in a hacky check here 136 | if options.push_all and options.target_name: 137 | print("WARNING: --all was specified so ignoring --name option") 138 | options.target_name = None 139 | 140 | # Unless we've only been asked for JSS info, we need a tag or branch to do anything 141 | if not options.jss_info and (not (options.branch or options.tag)): 142 | parser.error(("Which tag or branch HEAD do you want to push?\n" 143 | "Please specify with '--tag' or '--branch'")) 144 | 145 | # Can't specify --branch and --tag 146 | if options.branch and options.tag: 147 | parser.error( 148 | "Please specify --branch or --tag, but not both!") 149 | 150 | # We need to know which files to operate on! 151 | if (options.tag or options.branch) and not (options.source_file or options.push_all): 152 | parser.error("You need to specify either a filename " 153 | "(--file FILE) or all files (--all)") 154 | 155 | return options 156 | 157 | def main(argv=None, prefs_file=None): 158 | """ Main function """ 159 | options = _get_args(argv) 160 | 161 | prefs_file = prefs_file or options.prefs_file or find_prefs_file() 162 | 163 | target_type = set_mode(options) 164 | 165 | try: 166 | if options.no_keychain: 167 | jss_prefs = jss.JSSPrefs(preferences_file=prefs_file) 168 | else: 169 | # Use our subclass for keychain support 170 | jss_prefs = KJSSPrefs(preferences_file=prefs_file) 171 | except xml.parsers.expat.ExpatError as err: 172 | raise Git2JSSError("Preferences file {} invalid: {}".format(prefs_file, err)) 173 | 174 | # Create a new JSS object 175 | _jss = jss.JSS(jss_prefs) 176 | 177 | # If '--jss-info' was requested, just give the information 178 | if options.jss_info: 179 | print_jss_info(jss_prefs) 180 | sys.exit(0) 181 | 182 | _repo = GitRepo(tag=options.tag, branch=options.branch, sourcedir=options.local_repo) 183 | 184 | try: 185 | if options.push_all: 186 | files = list_matching_files(options.local_repo, pattern=r'.*\.(sh|py|pl)$') 187 | else: 188 | files = [options.source_file] 189 | for this_file in files: 190 | # Work out which type of processor to use 191 | processor_type = getattr(processors, target_type) 192 | 193 | # Instantiate the processor 194 | processor = processor_type(repo=_repo, _jss=_jss, 195 | source_file=this_file, 196 | target=options.target_name) 197 | 198 | processor.update() 199 | processor.save() 200 | finally: 201 | # Make sure the repo tmpdir is 202 | # cleaned up. 203 | _repo.__del__() 204 | 205 | 206 | def set_mode(options): 207 | """ Select a processor to use """ 208 | mode = options.mode 209 | print("Running in {} mode".format(mode)) 210 | return mode 211 | 212 | 213 | def find_prefs_file(): 214 | """ Return the platform-specific location of our prefs file """ 215 | if jss.tools.is_osx(): 216 | prefs_file = os.path.join('~', 'Library', 'Preferences', 217 | 'com.github.gkluoe.git2jss.plist') 218 | elif jss.tools.is_linux(): 219 | prefs_file = os.path.join("~", "." + 'com.github.gkluoe.git2jss.plist') 220 | 221 | return prefs_file 222 | 223 | 224 | def print_jss_info(jss_prefs): 225 | """ Print info about the currrently configured JSS 226 | """ 227 | print(("\nJSS: {}\n" 228 | "Username: {}\n" 229 | "File: {}\n").format(jss_prefs.url, 230 | jss_prefs.user, 231 | jss_prefs.preferences_file)) 232 | 233 | 234 | def list_matching_files(directory, pattern=r'.*\.(sh|py|pl)$'): 235 | """ Return a list of filenames in `directory` 236 | which match `pattern` """ 237 | return [x for x in os.listdir(directory) 238 | if not re.match(r'^\.', x) 239 | and re.match(pattern, x)] 240 | 241 | 242 | if __name__ == "__main__": 243 | main() 244 | -------------------------------------------------------------------------------- /git2jss/exceptions.py: -------------------------------------------------------------------------------- 1 | """ Exceptions for the git2jss module """ 2 | class Git2JSSError(Exception): 3 | """ Generic Git2JSSError """ 4 | pass 5 | -------------------------------------------------------------------------------- /git2jss/jss_keyring.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Copyright (C) 2014, 2015 Shea G Craig (part of python-jss) 3 | # 2018 Geoff Lee 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 | """ A subclass of Shea Craig's JSSPreferences, which supports storing 18 | passwords in the system keychain 19 | """ 20 | from __future__ import absolute_import, division, print_function 21 | import getpass 22 | import os 23 | import readline # pylint: disable=unused-import 24 | import subprocess 25 | from xml.etree import ElementTree 26 | from xml.parsers.expat import ExpatError 27 | from six.moves import input 28 | import jss 29 | from jss.exceptions import (JSSError, JSSPrefsMissingKeyError, 30 | JSSPrefsMissingFileError) 31 | 32 | from jss.tools import (is_osx, is_linux, loop_until_valid_response) 33 | 34 | try: 35 | from jss.contrib import FoundationPlist 36 | except ImportError as err: 37 | # If using OSX, FoundationPlist will need Foundation/PyObjC 38 | # available, or it won't import. 39 | 40 | if is_osx(): 41 | print("Warning: Import of FoundationPlist failed:", err) 42 | print("See README for information on this issue.") 43 | import plistlib 44 | 45 | import keyring 46 | 47 | class KJSSPrefs(jss.JSSPrefs): 48 | """ This is a subclass of the JSSPrefs class which stores passwords in 49 | the system keychain, rather than in plaintext in a preference file. 50 | """ 51 | 52 | def __init__(self, preferences_file=None): 53 | """Create a preferences object. 54 | This JSSPrefs object can be used as an argument for a new JSS. 55 | By default and with no arguments, it uses the preference domain 56 | "com.github.sheagcraig.python-jss.plist". However, alternate 57 | configurations can be supplied to the __init__ method to use 58 | something else. 59 | If no preferences file is specified, an interactive config 60 | method will run to help set up python-jss. 61 | See the JSSPrefs __doc__ for information on supported 62 | preferences. 63 | Args: 64 | preferences_file: String path to an alternate location to 65 | look for preferences. Defaults base on OS: 66 | OS X: "~/Library/Preferences/com.github.sheagcraig.python-jss.plist" 67 | Linux: "~/.com.github.sheagcraig.python-jss.plist" 68 | Raises: 69 | JSSError if using an unsupported OS. 70 | """ 71 | if preferences_file is None: 72 | plist_name = "com.github.sheagcraig.python-jss.plist" 73 | if is_osx(): 74 | preferences_file = os.path.join("~", "Library", "Preferences", 75 | plist_name) 76 | elif is_linux(): 77 | preferences_file = os.path.join("~", "." + plist_name) 78 | else: 79 | raise JSSError("Unsupported OS.") 80 | 81 | self.preferences_file = os.path.expanduser(preferences_file) 82 | if os.path.exists(self.preferences_file): 83 | self.parse_plist(self.preferences_file) 84 | 85 | else: 86 | self.configure() 87 | if not os.path.exists(self.preferences_file): 88 | raise JSSPrefsMissingFileError("Preferences file not found!") 89 | else: 90 | jss.JSSPrefs.__init__( 91 | self, preferences_file=self.preferences_file) # pylint: disable=non-parent-init-called 92 | 93 | def configure(self): 94 | """Prompt user for config and write to plist 95 | 96 | Uses preferences_file argument from JSSPrefs.__init__ as path 97 | to write. 98 | """ 99 | _get_user_input = jss.jss_prefs._get_user_input # pylint: disable=protected-access 100 | root = ElementTree.Element("dict") 101 | print(("It seems like you do not have a preferences file configured. " 102 | "Please answer the following questions to generate a plist at " 103 | "%s for use with python-jss.") % self.preferences_file) 104 | 105 | self.url = jss.jss_prefs._get_user_input( # pylint: disable=protected-access 106 | "The complete URL to your JSS, with port (e.g. " 107 | "'https://mycasperserver.org:8443')\nURL: ", "jss_url", root) 108 | 109 | self.user = _get_user_input("API Username: ", "jss_user", root) 110 | 111 | self.password = getpass.getpass("API User's Password: ") 112 | 113 | store_creds_in_keychain(self.url, self.user, self.password) 114 | 115 | print(("Password for jss %s has been stored" 116 | "in the system keychain") % self.url) 117 | 118 | verify_prompt = ("Do you want to verify that traffic is encrypted by " 119 | "a certificate that you trust?: (Y|N) ") 120 | self.verify = _get_user_input(verify_prompt, "verify", root, 121 | loop_until_valid_response) 122 | 123 | self._handle_repos(root) 124 | 125 | self._write_plist(root) 126 | print("Preferences created.\n") 127 | 128 | def parse_plist(self, preferences_file): 129 | """Try to reset preferences from preference_file.""" 130 | preferences_file = os.path.expanduser(preferences_file) 131 | 132 | # Try to open using FoundationPlist. If it's not available, 133 | # fall back to plistlib and hope it's not binary encoded. 134 | try: 135 | prefs = FoundationPlist.readPlist(preferences_file) 136 | except NameError: 137 | try: 138 | prefs = plistlib.readPlist(preferences_file) 139 | except ExpatError: 140 | # If we're on OSX, try to convert using another 141 | # tool. 142 | if is_osx(): 143 | subprocess.call(["plutil", "-convert", "xml1", 144 | preferences_file]) 145 | prefs = plistlib.readPlist(preferences_file) 146 | 147 | self.preferences_file = preferences_file 148 | 149 | self.user = prefs.get("jss_user") 150 | self.url = prefs.get("jss_url") 151 | 152 | plain_password = prefs.get("jss_pass") 153 | 154 | # Previous versions might have left a plaintext password in 155 | # a preferences file. Offer to move it to the keychain and 156 | # bail if the user refuses: this is, after all, the 'K'JSSPrefs 157 | # class. 158 | if self.url and self.user and plain_password: 159 | answer = None 160 | question = ("Warning: we found a plaintext password in the " 161 | "prefs file, and you didn't specify '--no-keychain'.\n" 162 | "git2jss can remove the plaintext password " 163 | "from the file and move it to the keychain for you. \n" 164 | "This is almost certainly a good idea unless you really " 165 | "know what you are doing, and just forgot the --no-keychain " 166 | "flag.\n") 167 | print(question) 168 | 169 | while answer not in ['y', 'n']: 170 | answer = input( 171 | 'Do you want to move the password out of the plist file? (y|n)') 172 | 173 | if answer == 'y': 174 | store_creds_in_keychain(self.url, self.user, plain_password) 175 | prefs.pop("jss_pass") 176 | self.write_plist_from_dict(prefs) 177 | print("Password moved into keychain") 178 | 179 | else: 180 | print(("OK, on your own head be it.\n" 181 | "You can use the --no-keychain flag to continue with " 182 | "the plaintext password.")) 183 | raise JSSError("Plaintext password without --no-keychain") 184 | 185 | # This will throw an exception if the password is missing 186 | self.password = get_creds_from_keychain(self.url, self.user) 187 | 188 | if not all([self.user, self.password, self.url]): 189 | raise JSSPrefsMissingKeyError("Some preferences are missing. Please " 190 | "delete %s and try again." % self.preferences_file) 191 | 192 | # Optional file repository array. Defaults to empty list. 193 | self.repos = [] 194 | for repo in prefs.get("repos", []): 195 | self.repos.append(dict(repo)) 196 | 197 | self.verify = prefs.get("verify", True) 198 | self.suppress_warnings = prefs.get("suppress_warnings", True) 199 | 200 | def write_plist_from_dict(self, prefs): 201 | """ Write the plist, using the values in the dict `prefs` """ 202 | root = ElementTree.Element("dict") 203 | 204 | for key_name in prefs.keys(): 205 | val = prefs.get(key_name) 206 | ElementTree.SubElement(root, "key").text = key_name 207 | if isinstance(val, bool): 208 | string_val = "true" if val else "false" 209 | ElementTree.SubElement(root, string_val) 210 | else: 211 | ElementTree.SubElement(root, "string").text = val 212 | self._write_plist(root) # pylint: disable protected-access 213 | 214 | 215 | def store_creds_in_keychain(service, user, pwd): 216 | """ Attempt to store the JSS credentials in the keychain """ 217 | try: 218 | keyring.set_password(service, user, pwd) 219 | except keyring.errors.KeyringError as error: 220 | print("Failed to store credentials in keychain: {}".format(error)) 221 | print("If you are running in a virtualenv, this is expected") 222 | print("See: https://github.com/jaraco/keyring/issues/219") 223 | raise 224 | 225 | 226 | def get_creds_from_keychain(service, user): 227 | """" Fetch the credentials for `jss_url` from the keychain """ 228 | try: 229 | result = keyring.get_password(service, user) 230 | except keyring.errors.KeyringError as error: 231 | print("Failed to get credentials from keychain: {}".format(error)) 232 | print("If you are running in a virtualenv, this is expected") 233 | print("See: https://github.com/jaraco/keyring/issues/219") 234 | raise 235 | if result: 236 | return result 237 | else: 238 | raise keyring.errors.KeyringError(("Couldn't find a password in the keychain for\n" 239 | "%s on %s" % (user, service))) 240 | -------------------------------------------------------------------------------- /git2jss/processors.py: -------------------------------------------------------------------------------- 1 | """ Processors which take sync an object in the JSS 2 | with a copy in version control. """ 3 | from __future__ import absolute_import, print_function 4 | import os 5 | from base64 import b64encode 6 | from string import Template 7 | import jss 8 | 9 | class TargetNotFoundError(Exception): 10 | """ Target wasn't found """ 11 | pass 12 | 13 | # pylint: disable=too-many-instance-attributes 14 | class JSSObject(object): 15 | """ Generic Object """ 16 | 17 | vcs = None 18 | jss = None 19 | 20 | source_name = None 21 | source_file_path = None 22 | source_file = None 23 | target_name = None 24 | target_object = None 25 | 26 | def __init__(self, repo, _jss, source_file, 27 | target=None, target_type='Script'): 28 | """ Load source file from the vcs and 29 | target object from the JSS 30 | 31 | `repo` should be a repo from the vcs module 32 | `jss` should be a JSS object 33 | `source_file` should be the path to the source file 34 | """ 35 | 36 | # The name of the source file, minus any path 37 | self.source_name = (os.path.basename(source_file)) 38 | 39 | # Full path to the source file 40 | self.source_file_path = source_file 41 | 42 | # If we haven't been provided a target name, assume 43 | # it's the name of the source file 44 | self.target_name = target or self.source_name 45 | 46 | self.target_type = target_type 47 | self.repo = repo 48 | self._jss = _jss 49 | 50 | self._load_target_object() 51 | self._load_source_file() 52 | 53 | def _load_target_object(self): 54 | """ Load the target object from the JSS 55 | """ 56 | try: 57 | # Calls _jss.'target_type'(): eg _jss.Script() 58 | jss_method = getattr(self._jss, self.target_type) 59 | self.target_object = jss_method(self.target_name) 60 | except jss.JSSGetError as err: 61 | if err.status_code == 404: # pylint: disable=E1101 62 | raise TargetNotFoundError( 63 | "Couldn't find a {} called '{}' on the JSS" 64 | .format(self.target_type, self.target_name)) 65 | else: 66 | raise 67 | else: 68 | print("Loaded {} from the JSS".format(self.target_name)) 69 | 70 | def _load_source_file(self): 71 | """ Load the source file from the VCS 72 | """ 73 | try: 74 | self.source_file = self.repo.get_file(self.source_file_path) 75 | except: 76 | raise 77 | else: 78 | print ("Loaded {} from version control".format(self.source_file_path)) 79 | 80 | def update(self, should_template): 81 | """ Stub method which should be overriden for 82 | different types of object which subclass this one 83 | """ 84 | pass 85 | 86 | def save(self): 87 | """ Write the object back to the JSS 88 | """ 89 | try: 90 | self.target_object.save() 91 | except: 92 | raise 93 | else: 94 | print("Saved {} to the jss".format(self.target_name)) 95 | 96 | 97 | class Script(JSSObject): 98 | """ A Script """ 99 | 100 | OBJECT_TYPE = "Script" 101 | 102 | def __init__(self, *args, **kwargs): 103 | kwargs['target_type'] = self.OBJECT_TYPE 104 | super(Script, self).__init__(*args, **kwargs) 105 | 106 | def update(self, should_template=True): 107 | """ Update the notes field to contain the git log, 108 | and, if requested, template the script 109 | """ 110 | 111 | info = self.repo.file_info(self.source_file_path) 112 | 113 | # Add log to the notes field 114 | self.target_object.find('notes').text = info['LOG'] 115 | 116 | # Update the script - we need to write a base64 encoded version 117 | # of the contents of the source file into the 'script_contents_encoded' 118 | # element of the script object. 119 | if should_template: 120 | print("Templating file...") 121 | self.target_object.find('script_contents_encoded').text = b64encode( 122 | template_file(self.source_file, 123 | info, 124 | USER=self._jss.user).encode('utf-8')) 125 | else: 126 | print("No templating requested.") 127 | self.target_object.find('script_contents_encoded').text = b64encode( 128 | self.source_file.read().encode('utf-8')) 129 | 130 | # According to the JAMF Pro API, only one of script_contents and 131 | # script_contents_encoded should be sent, so delete the one we are not using. 132 | self.target_object.remove(self.target_object.find('script_contents')) 133 | 134 | 135 | class ComputerExtensionAttribute(JSSObject): 136 | """ A ComputerExtensionAttribute """ 137 | 138 | OBJECT_TYPE = "ComputerExtensionAttribute" 139 | 140 | def __init__(self, *args, **kwargs): 141 | kwargs['target_type'] = self.OBJECT_TYPE 142 | super(ComputerExtensionAttribute, self).__init__(*args, **kwargs) 143 | 144 | def update(self, should_template=True): 145 | """ Update the notes field to contain the git log, 146 | and, if requested, template the script 147 | """ 148 | info = self.repo.file_info(self.source_file_path) 149 | 150 | # Add log to the description field 151 | self.target_object.find('description').text = info['LOG'] 152 | 153 | # Template, or not, and save the result to the 'Mac' 154 | # script section of the ComputerExtensionAttribute 155 | if should_template: 156 | print("Templating file...") 157 | output = template_file(self.source_file, info, 158 | USER=self._jss.user) 159 | else: 160 | print("No templating requested.") 161 | output = self.source_file.read() 162 | 163 | self.target_object.find("input_type/[platform='Mac']/script").text = output 164 | 165 | 166 | def template_file(handle, data, **kwargs): 167 | """ Template a file. Pass in an open 168 | file handle and receive a string containing 169 | the templated text. We use a custom delimiter to 170 | reduce the risk of collisions 171 | """ 172 | 173 | class JSSTemplate(Template): 174 | """ Template subclass with a custom delimiter """ 175 | delimiter = '@@' 176 | 177 | text = handle.read() 178 | tmpl = JSSTemplate(text) 179 | out = None 180 | try: 181 | out = tmpl.safe_substitute(data, **kwargs) 182 | except: 183 | print("Failed to template this script.") 184 | raise 185 | 186 | return out 187 | -------------------------------------------------------------------------------- /git2jss/vcs.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Copyright (C) 2018 Geoff Lee 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | """ Model for interacting with VCSs """ 18 | from __future__ import absolute_import, division, print_function 19 | import subprocess 20 | import tempfile 21 | import shutil 22 | import re 23 | import os 24 | import io 25 | from git2jss.exceptions import Git2JSSError 26 | 27 | 28 | class RefNotFoundError(Git2JSSError): 29 | """ Ref wasn't found """ 30 | pass 31 | 32 | 33 | class TooManyRemotesError(Git2JSSError): 34 | """ We can only handle one remote """ 35 | pass 36 | 37 | 38 | class NoRemoteError(Git2JSSError): 39 | """ There needs to be at least one remote """ 40 | 41 | 42 | class FileNotFoundError(Git2JSSError): 43 | """ File Not Found """ 44 | pass 45 | 46 | 47 | class NotAGitRepoError(Git2JSSError): 48 | """ Dir is not a git repo """ 49 | pass 50 | 51 | class ParameterError(Git2JSSError): 52 | """ Method called with unusable parameters """ 53 | pass 54 | 55 | class GitRepo(object): 56 | """ Provides a representation of a Git repository at a particular 57 | point in time, with methods to retrieve files and information. 58 | """ 59 | 60 | def __init__(self, tag=None, branch=None, sourcedir='.'): 61 | """ Create a GitRepo object which represents the 62 | remote repository. The remote repository will be cloned using 63 | the `tag` OR `branch` specified. `tag` and `branch` together 64 | is an error. 65 | 66 | :param tag: The VCS tag to use to base this object on 67 | :param branch: The VCS reference to use to base this object on 68 | :param sourcedir: (optional) The local directory from which to 69 | glean informaton about the remote repository. Defaults to '.' 70 | :rtype: vcs.GitRepo 71 | """ 72 | 73 | self.tag = tag 74 | self.branch = branch 75 | 76 | if not (tag or branch): 77 | raise ParameterError("Specify only one of `tag` or `branch`") 78 | 79 | # The reference we will use to clone the repo from 80 | self.ref = tag or branch 81 | 82 | self.sourcedir = sourcedir 83 | self.tmp_dir = tempfile.mkdtemp() 84 | 85 | try: 86 | self.remote_name = self._find_remote_name() 87 | 88 | except subprocess.CalledProcessError as err: 89 | if err.output.find('Not a git repository'): 90 | raise NotAGitRepoError(err.output) 91 | 92 | self.remote_url = self._find_remote_url() 93 | 94 | if self._has_ref_on_remote(self.ref): 95 | self._clone_to_tmp() 96 | else: 97 | raise RefNotFoundError("Tag or branch {} doesn't exist on git remote {}" 98 | .format(self.ref, self.remote_url)) 99 | 100 | def __del__(self): 101 | """ Called when there are 0 references left to this 102 | object. Try to delete our temporary directory. 103 | """ 104 | # I don't think this is the best way to do this. 105 | # we should be using a context manager but I don't know 106 | # how to make that work in this situation 107 | 108 | # Clean up our temp dir, cheking whether things still 109 | # exist first. 110 | if os is not None and self.tmp_dir is not None: 111 | if os.path.exists(self.tmp_dir): 112 | print("Cleaning up tmpdir {}".format(self.tmp_dir)) 113 | shutil.rmtree(self.tmp_dir) 114 | 115 | def _find_remote_name(self): 116 | """ Find the name of the current git remote configured 117 | for local repository `directory`. 118 | Repositories with more than 1 remote are not 119 | currently supported. 120 | """ 121 | remotes = subprocess.check_output(['git', 'remote'], 122 | cwd=self.sourcedir).strip().split('\n') 123 | 124 | if len(remotes) > 1: 125 | raise TooManyRemotesError( 126 | "Don't know how to handle more than 1 remote: {}".format(remotes)) 127 | elif len(remotes) < 1 or remotes[0] == '': 128 | raise NoRemoteError("No Git remote is configured") 129 | 130 | return remotes[0] 131 | 132 | def _find_remote_url(self): 133 | """ Divine the URL of our git remote, using the 134 | name in self.remote_name 135 | """ 136 | print("Remote: {}".format(self.remote_name)) 137 | 138 | _url = subprocess.check_output(["git", "config", "--get", 139 | "remote." + self.remote_name + 140 | ".url"], cwd=self.sourcedir).strip() 141 | # Normalise URL to not end with '.git' 142 | if re.search(r'\.git$', _url): 143 | _url = _url[:-4] 144 | 145 | return _url 146 | 147 | def _clone_to_tmp(self): 148 | """ Clone fresh copy of the repo we are going to operate on 149 | self.ref must be present as a tag or branch on the git remote 150 | """ 151 | print("Git remote: {}".format(self.remote_url)) 152 | # Use check_output to suppress stdout, which is rather chatty 153 | # even with '-q'. 154 | try: 155 | subprocess.check_output(["git", "clone", "-q", "--branch", 156 | self.ref, self.remote_url + ".git", 157 | self.tmp_dir], stderr=subprocess.STDOUT) 158 | except subprocess.CalledProcessError as err: 159 | # Don't know what happened! 160 | raise Git2JSSError(err.output) 161 | else: 162 | print("Checked out repo at {}.".format(self.ref)) 163 | 164 | 165 | def _format_commit(self, filename): 166 | """ Return a string combining the commit ID and branch 167 | of `filename` to be the 'version' of a file in this repo. 168 | """ 169 | commit = subprocess.check_output(["git", "log", 170 | "-1", "--format=%H", 171 | filename], cwd=self.tmp_dir).strip() 172 | 173 | return '{} on branch: {}'.format(commit, self.branch) 174 | 175 | def file_info(self, filename): 176 | """ Return a dict of information about `filename` 177 | :param filename: path to a file relative to the root of the repository 178 | :rtype: Dict 179 | """ 180 | if self.has_file(filename): 181 | git_info = {} 182 | git_info['VERSION'] = self.tag or self._format_commit(filename) 183 | git_info['ORIGIN'] = self.remote_url 184 | git_info['PATH'] = filename 185 | git_info['DATE'] = subprocess.check_output(["git", "log", 186 | "-1", '--format="%ad"', 187 | filename], cwd=self.tmp_dir).strip() 188 | git_info['LOG'] = subprocess.check_output(["git", "log", 189 | '--format=%h - %cD %ce: %n %s%n', 190 | filename], cwd=self.tmp_dir).strip() 191 | return git_info 192 | else: 193 | raise FileNotFoundError("Couldn't find file {} at ref {}" 194 | .format(filename, self.ref)) 195 | 196 | def path_to_file(self, filename): 197 | """ Return absolute path to `filename` inside 198 | our temporary directory 199 | :param filename: path to a file relative to the root of the 200 | repository 201 | :rtype: String 202 | """ 203 | path = os.path.join(self.tmp_dir, filename) 204 | if self.has_file(filename): 205 | return os.path.abspath(path) 206 | else: 207 | raise FileNotFoundError("Couldn't find file {} at tag/branch {}" 208 | .format(filename, self.ref)) 209 | 210 | def has_file(self, filename): 211 | """ Return True if `filename` exists in this 212 | repo at this tag/branch. False if not 213 | :param filename: path to a file relative to the root of the 214 | repository 215 | :rtype: Bool 216 | """ 217 | path = os.path.join(self.tmp_dir, filename) 218 | return os.path.isfile(os.path.abspath(path)) 219 | 220 | def get_file(self, filename): 221 | """ Return an open file handle to `filename` 222 | :param filename: path to a file relative to the root of the 223 | repsitory 224 | :rtype: File-like object 225 | """ 226 | handle = io.open(self.path_to_file(filename), 'r', encoding="utf-8") 227 | return handle 228 | 229 | def _has_ref_on_remote(self, r_name): 230 | """ Check whether a tag or branch `r_name` exists in 231 | the current repo 232 | :rtype: Boolean 233 | """ 234 | # Get refs from the git remote 235 | reflist = subprocess.check_output(['git', 'ls-remote', '--refs'], 236 | cwd=self.sourcedir) 237 | 238 | # Parse into a list of tags and branches that exist on the git remote 239 | refs = [t.split('\t')[-1:][0].split('/')[-1:][0] for t in reflist.split('\n')] 240 | # Does tag exist? 241 | return r_name in refs 242 | -------------------------------------------------------------------------------- /release.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Use this script to generate a new relese 3 | # It will create a new tag push it to github and push a source distribution to pypi 4 | 5 | # Bail immediately if anything fails 6 | set -Eeuo pipefail 7 | 8 | pip install bumpversion twine 9 | 10 | release_level=${1} 11 | 12 | if [ "${release_level}" == "major" ] ||\ 13 | [ "${release_level}" == "minor" ] ||\ 14 | [ "${release_level}" == "patch" ] 15 | then 16 | bump_args="--list ${release_level}" 17 | elif [ ! -z "${release_level}" ] 18 | then 19 | bump_args="--list --new-version=${release_level} patch" 20 | else 21 | echo "Specify major, minor or patch" 22 | exit 1 23 | fi 24 | 25 | git checkout master 26 | 27 | git pull 28 | 29 | #python setup.py test 30 | 31 | # First bump a new version - this creates a new git tag 32 | new_version="$(bumpversion --tag ${bump_args} | awk -F '=' '/new_version/ {print $2}')" 33 | 34 | # Commit the tag 35 | git push origin v"${new_version}" 36 | 37 | rm -rf dist/* 38 | 39 | # Build source distribution 40 | python setup.py sdist 41 | python setup.py bdist_wheel 42 | 43 | # Upload to pypi 44 | twine upload dist/* 45 | 46 | # Build a package using autopkg 47 | autopkg run --verbose -d autopkg-recipe git2jss.pkg 48 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Dev/Deployment 2 | pytest 3 | pytest-runner 4 | pypi-publisher 5 | pylint 6 | # Install 7 | python-jss 8 | keyring 9 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [bumpversion] 2 | current_version = 2.0.0 3 | parse = ^ 4 | (?P\d+)\.(?P\d+)\.(?P\d+) # minimum 'N.N.N' 5 | (?: 6 | (?P[abc]|rc|dev) # 'a' = alpha, 'b' = beta 7 | (?: 8 | (?P\d+(?:\.\d+)*) 9 | )? 10 | )? 11 | (?P(\.post(?P\d+))?(\.dev(?P\d+))?)? 12 | serialize = 13 | {major}.{minor}.{patch}{prerel}{prerelversion} 14 | {major}.{minor}.{patch}{prerel} 15 | {major}.{minor}.{patch} 16 | 17 | [bumpversion:part:prerel] 18 | values = 19 | dev 20 | a 21 | b 22 | c 23 | rc 24 | d 25 | optional_value = d 26 | 27 | [aliases] 28 | test = pytest 29 | 30 | [bdist_wheel] 31 | universal = 1 32 | 33 | [tool:pytest] 34 | addopts = --verbose 35 | markers = 36 | need_jss: Requires a JSS 37 | 38 | [bumpversion:file:setup.py] 39 | 40 | [bumpversion:file:README.rst] 41 | 42 | [bumpversion:file:autopkg-recipe/git2jss.pkg.recipe] 43 | 44 | [bumpversion:file:git2jss/__init__.py] 45 | 46 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from codecs import open 3 | from os import path 4 | import sys 5 | 6 | __version__ = '2.0.0' 7 | 8 | here = path.abspath(path.dirname(__file__)) 9 | 10 | # Get the long description from the README file 11 | with open(path.join(here, 'README.rst'), encoding='utf-8') as f: 12 | long_description = f.read() 13 | 14 | setup( 15 | name='git2jss', 16 | version=__version__, 17 | description='Push scripts from a Git repo to a JSS. Includes templating and tagging.', 18 | long_description=long_description, 19 | url='https://github.com/gkluoe/git2jss', 20 | download_url='https://github.com/gkluoe/git2jss/tarball/v' + __version__, 21 | license='Apache Software License', 22 | classifiers=[ 23 | 'Development Status :: 4 - Beta', 24 | 'Intended Audience :: Developers', 25 | 'License :: OSI Approved :: Apache Software License', 26 | 'Programming Language :: Python :: 2', 27 | ], 28 | keywords='JAMF jss git release', 29 | packages=find_packages(exclude=['docs', 'tests*']), 30 | include_package_data=True, 31 | author='Geoff Lee', 32 | install_requires=['python-jss', 'keyring'], 33 | author_email='g.lee@ed.ac.uk', 34 | setup_requires = ['pytest-runner'], 35 | tests_require = ['pytest-runner', 'pytest', 'pylint', 'mock'], 36 | entry_points={ 37 | 'console_scripts': [ 38 | 'git2jss = git2jss.__init__:main' 39 | ] 40 | }, 41 | ) 42 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | import tempfile 3 | import plistlib 4 | import subprocess 5 | import os 6 | import jss 7 | import git2jss.vcs as vcs 8 | 9 | # This filecontains all of our fixtures 10 | 11 | 12 | # This is brain-melting. See: 13 | # https://stackoverflow.com/questions/18011902/py-test-pass-a-parameter-to-a-fixture-function 14 | # and 15 | # https://docs.pytest.org/en/latest/fixture.html 16 | # 17 | # The idea here is that this fixture returns a function which takes an optional argument 18 | # containing the data that we want in our test preferences file. 19 | 20 | @pytest.fixture(scope='session', name='git2jss_test_repo') 21 | def fixture_git2jss_test_repo(): 22 | return 'https://github.com/gkluoe/git2jss-test.git' 23 | 24 | 25 | 26 | @pytest.fixture(scope="function", name="prefs_file_no_keychain") 27 | def fixture_prefs_file_no_keychain(request): 28 | """ Return a function which creates a test prefs file 29 | and cleans up afterwards 30 | """ 31 | def make_test_prefs(prefs_data=None): 32 | """ Create a test preferences file and clean up afterwards """ 33 | default_data = {"jss_url": u"https://some.domain.example.com/directory:port", 34 | "jss_user": u"slartibartfarst", 35 | "jss_pass": u"123blah456blah"} 36 | 37 | prefs_data = prefs_data or default_data 38 | prefs_file = tempfile.mktemp() 39 | plistlib.writePlist(prefs_data, prefs_file) 40 | 41 | def fin(): 42 | """ Delete temp file """ 43 | print("Deleting temp prefs file") 44 | os.unlink(prefs_file) 45 | request.addfinalizer(fin) 46 | 47 | return prefs_file 48 | return make_test_prefs 49 | 50 | @pytest.fixture(scope="function", name="check_prefs_values") 51 | def fixture_check_prefs_values(prefs_file_no_keychain): 52 | def _check_prefs_values(prefs_file_no_keychain, prefs_data): 53 | """ Check that the values in a JSSPrefs object instantiated 54 | using the file `test_prefs` match the values in `prefs_data` 55 | """ 56 | jss_prefs = jss.JSSPrefs(preferences_file=prefs_file_no_keychain) 57 | 58 | assert jss_prefs.user == prefs_data.get('jss_user') 59 | assert jss_prefs.url == prefs_data.get('jss_url') 60 | assert jss_prefs.password == prefs_data.get('jss_pass') 61 | return _check_prefs_values 62 | 63 | 64 | @pytest.fixture(scope="session", name="a_jss") 65 | def fixture_a_jss(): 66 | # You'll need to create this file... 67 | prefs = jkc.KJSSPrefs(preferences_file='tests/com.github.gkluoe.git2jss.plist') 68 | JSS = jss.JSS(prefs) 69 | return JSS 70 | 71 | @pytest.fixture(scope="session", name="jss_repo") 72 | def fixture_jss_repo(tmpdir_factory): 73 | """ Return a valid GitRepo object """ 74 | tmp_dir = str(tmpdir_factory.mktemp('source_gitrepo')) 75 | subprocess.check_call(['git', 'clone', 'https://github.com/uoe-macos/jss', tmp_dir]) 76 | return tmp_dir 77 | 78 | 79 | @pytest.fixture(scope='session', name='a_gitrepo') 80 | def fixture_a_gitrepo(jss_repo): 81 | repo = vcs.GitRepo(tag='0.0.49', sourcedir=jss_repo) 82 | return repo 83 | 84 | 85 | @pytest.fixture(scope="session", name="gitrepo") 86 | def fixture_gitrepo(tmpdir_factory, git2jss_test_repo): 87 | """ Return a valid GitRepo object """ 88 | tmp_dir = str(tmpdir_factory.mktemp('gitrepo')) 89 | _build_local_repo(tmp_dir, remote=git2jss_test_repo) 90 | return vcs.GitRepo(tag='test-1.0.0', 91 | sourcedir=tmp_dir) 92 | 93 | 94 | @pytest.fixture(scope="session", name="gitrepo_master") 95 | def fixture_gitrepo_master(tmpdir_factory, git2jss_test_repo): 96 | """ Return a valid GitRepo object """ 97 | tmp_dir = str(tmpdir_factory.mktemp('gitrepo')) 98 | _build_local_repo(tmp_dir, remote=git2jss_test_repo) 99 | return vcs.GitRepo(branch='master', 100 | sourcedir=tmp_dir) 101 | 102 | @pytest.fixture(scope="session", name="gitrepo_branch001") 103 | def fixture_gitrepo_branch001(tmpdir_factory, git2jss_test_repo): 104 | """ Return a valid GitRepo object """ 105 | tmp_dir = str(tmpdir_factory.mktemp('gitrepo')) 106 | _build_local_repo(tmp_dir, remote=git2jss_test_repo) 107 | return vcs.GitRepo(branch='branch001', 108 | sourcedir=tmp_dir) 109 | 110 | 111 | def _build_local_repo(test_dir, remote=None): 112 | """ Build a fresh local git repo. 113 | if `remote` is specified, add the URL 114 | to the repo as a new git remote 115 | """ 116 | subprocess.call(["git", "init", "."], 117 | cwd=test_dir) 118 | if remote: 119 | subprocess.call(["git", "remote", 120 | "add", "origin", 121 | remote], cwd=test_dir) 122 | -------------------------------------------------------------------------------- /tests/test_git2jss.py: -------------------------------------------------------------------------------- 1 | # --*-- encoding: utf-8 --*-- 2 | """ General tess """ 3 | from __future__ import print_function 4 | import plistlib 5 | import tempfile 6 | import os 7 | import getpass 8 | from collections import deque 9 | import pytest 10 | from pytest import raises 11 | 12 | import jss 13 | import git2jss.jss_keyring 14 | import mock 15 | from mock import patch 16 | 17 | 18 | def test_get_prefs_unicode(prefs_file_no_keychain, check_prefs_values): 19 | """ Can we get our prefs? Can they handle unicode? """ 20 | prefs_data = {"jss_url": u"https://some.domain.example.com/directory:port", 21 | "jss_user": u"ਫ ਬ ਭ 1 2 3", 22 | "jss_pass": u"զ է ը թ 4 5 6"} 23 | 24 | check_prefs_values(prefs_file_no_keychain( 25 | prefs_data=prefs_data), prefs_data) 26 | 27 | 28 | def test_get_prefs_ascii(prefs_file_no_keychain, check_prefs_values): 29 | """ Can we get our prefs? Can they handle unicode? """ 30 | prefs_data = {"jss_url": u"https://some.domain.example.com/directory:port", 31 | "jss_user": u"slartibartfarst", 32 | "jss_pass": u"123blah456blah"} 33 | 34 | check_prefs_values(prefs_file_no_keychain( 35 | prefs_data=prefs_data), prefs_data) 36 | 37 | 38 | def test_jss_info_no_keychain(prefs_file_no_keychain, capsys): 39 | """ Test displaying JSS info when we are not using the 40 | system keychain 41 | """ 42 | args = ["--jss-info", "--no-keychain"] 43 | with pytest.raises(SystemExit): 44 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 45 | out = capsys.readouterr()[0] 46 | assert out.find( 47 | """JSS: https://some.domain.example.com/directory:port\nUsername: slartibartfarst""") 48 | 49 | 50 | def test_jss_info_no_keychain_prefs_commandline(capsys, prefs_file_no_keychain): 51 | args = ["--jss-info", "--no-keychain", "--prefs-file", prefs_file_no_keychain()] 52 | with pytest.raises(SystemExit): 53 | git2jss.main(argv=args) 54 | out = capsys.readouterr()[0] 55 | assert out.find( 56 | """JSS: https://some.domain.example.com/directory:port\nUsername: slartibartfarst""") 57 | 58 | def test_exception_prefs_commandline_invalid(capsys): 59 | args = ["--jss-info", "--no-keychain", "--prefs-file", "/etc/passwd"] 60 | with pytest.raises(git2jss.exceptions.Git2JSSError): 61 | git2jss.main(argv=args) 62 | out = capsys.readouterr()[0] 63 | assert out.find( 64 | """Preferences file""") 65 | 66 | def test_prefs_setup(capsys, monkeypatch): 67 | from functools import partial 68 | import getpass 69 | import requests 70 | 71 | def _make_multiple_inputs(inputs): 72 | """ provides a function to call for every input requested. """ 73 | def next_input(_): 74 | """ provides the first item in the list. """ 75 | return inputs.popleft() 76 | return next_input 77 | 78 | prefs_values = {"jss_url": u"https://git2jss.test.example.com/url:9999", 79 | "jss_user": u"liasufgoadsvbousyvboads8yvoasduvhybouvybasdouvybas", 80 | "jss_pass": u"ufygasiufygasdoufygasoufygaoduygasdoufyasdgouasydgfoa"} 81 | 82 | # Patch the builtin raw_input, and the getpass.getpass funtcion to return 83 | # some values that we would expect a user to type. 84 | monkeypatch.setitem(__builtins__, 'raw_input', _make_multiple_inputs( 85 | deque([prefs_values['jss_url'], prefs_values['jss_user'], "N", "N", "N", "N", "N", "N", "N"]))) 86 | 87 | monkeypatch.setattr('getpass.getpass', lambda x: prefs_values['jss_pass']) 88 | 89 | # The _get_user_input() function's default value has already mapped a variable to 90 | # the unmodified version of raw_input, so we need to reload it at this point to give 91 | # the function access to our patched version. 92 | reload(jss.jss_prefs) 93 | 94 | # We don't care about the underlying module's handling of distribution servers 95 | # and patching out this function avoids us attemoting to connect to the JSS. 96 | monkeypatch.setattr('jss.jss_prefs._handle_dist_server', lambda x, y: "") 97 | 98 | # We also don't care about repositories 99 | monkeypatch.setattr( 100 | 'git2jss.jss_keyring.KJSSPrefs._handle_repos', lambda x, y: "") 101 | 102 | # Now we can do stuff. Test that the preferences creation routine stores the 103 | # credentials and cam retrieve them from its prefs file. 104 | prefs_file = tempfile.mktemp() 105 | with pytest.raises(SystemExit): 106 | git2jss.main(argv=['--jss-info'], prefs_file=prefs_file) 107 | 108 | out = capsys.readouterr()[0] 109 | assert out.find("JSS: {}".format(prefs_values['jss_url'])) 110 | assert out.find("Username: {}".format(prefs_values['jss_url'])) 111 | assert out.find("File: {}".format(prefs_file)) 112 | 113 | # The password should have been stored in the system keychain: 114 | keychain_password = git2jss.jss_keyring.get_creds_from_keychain(prefs_values['jss_url'], 115 | prefs_values['jss_user']) 116 | 117 | assert(keychain_password == prefs_values['jss_pass']) 118 | 119 | os.unlink(prefs_file) 120 | 121 | @pytest.mark.need_jss 122 | def test_create_script_from_custom_src_branch(jss_repo): 123 | args = ["--mode", "Script", 124 | "--file", "coreconfig-softwareupdate-run.py", 125 | "--local-repo", jss_repo, 126 | "--name", "macad-2018-test.py", 127 | "--branch", "master"] 128 | git2jss.main(argv=args) 129 | # TODO: check that the created script is what we expect 130 | 131 | @pytest.mark.need_jss 132 | def test_create_script_from_dot_branch(jss_repo): 133 | cwd = os.getcwd() 134 | try: 135 | os.chdir(jss_repo) 136 | args = ["--mode", "Script", 137 | "--file", "coreconfig-softwareupdate-run.py", 138 | "--name", "macad-2018-test.py", 139 | "--branch", "master"] 140 | git2jss.main(argv=args) 141 | finally: 142 | os.chdir(cwd) 143 | # TODO: check that the created script is what we expect 144 | 145 | @pytest.mark.need_jss 146 | def test_create_script_from_custom_src_tag(jss_repo): 147 | args = ["--mode", "Script", 148 | "--file", "coreconfig-softwareupdate-run.py", 149 | "--local-repo", os.path.join(os.getcwd(), jss_repo), 150 | "--name", "macad-2018-test.py", 151 | "--local-repo", jss_repo, 152 | "--tag", "0.0.49"] 153 | git2jss.main(argv=args) 154 | # TODO: check that the created script is what we expect 155 | 156 | @pytest.mark.need_jss 157 | def test_create_script_from_dot_tag(jss_repo): 158 | cwd = os.getcwd() 159 | try: 160 | os.chdir(jss_repo) 161 | args = ["--mode", "Script", 162 | "--file", "coreconfig-softwareupdate-run.py", 163 | "--name", "macad-2018-test.py", 164 | "--tag", "0.0.49"] 165 | git2jss.main(argv=args) 166 | finally: 167 | os.chdir(cwd) 168 | # TODO: check that the created script is what we expect 169 | 170 | def test_exception_invalid_tag(prefs_file_no_keychain, jss_repo): 171 | args = ["--mode", "Script", 172 | "--file", "coreconfig-softwareupdate-run.py", 173 | "--local-repo", jss_repo, 174 | "--name", "macad-2018-test.py", 175 | "--tag", "notatag", 176 | "--no-keychain"] 177 | with raises(git2jss.vcs.RefNotFoundError): 178 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 179 | 180 | def test_exception_invalid_branch(prefs_file_no_keychain, jss_repo): 181 | args = ["--mode", "Script", 182 | "--file", "coreconfig-softwareupdate-run.py", 183 | "--local-repo", jss_repo, 184 | "--name", "macad-2018-test.py", 185 | "--branch", "notabranch", 186 | "--no-keychain"] 187 | with raises(git2jss.vcs.RefNotFoundError): 188 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 189 | 190 | @pytest.mark.need_jss 191 | def test_exception_invalid_target(jss_repo): 192 | args = ["--mode", "Script", 193 | "--file", "coreconfig-softwareupdate-run.py", 194 | "--local-repo", jss_repo, 195 | "--name", "NotAJSSObject", 196 | "--tag", "0.0.49"] 197 | with raises(git2jss.processors.TargetNotFoundError): 198 | git2jss.main(argv=args) 199 | 200 | def test_exception_invalid_repo(prefs_file_no_keychain): 201 | args = ["--mode", "Script", 202 | "--file", "coreconfig-softwareupdate-run.py", 203 | "--local-repo", "/tmp", 204 | "--name", "macad-2018-test.py", 205 | "--tag", "0.0.49", 206 | "--no-keychain"] 207 | with raises(git2jss.vcs.NotAGitRepoError): 208 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 209 | 210 | @pytest.mark.need_jss 211 | def test_exception_invalid_file(jss_repo): 212 | args = ["--mode", "Script", 213 | "--file", "NotAFile", 214 | "--local-repo", jss_repo, 215 | "--name", "macad-2018-test.py", 216 | "--tag", "0.0.49", 217 | ] 218 | with raises(git2jss.vcs.FileNotFoundError): 219 | git2jss.main(argv=args) 220 | 221 | 222 | def test_exception_invalid_mode(capsys, prefs_file_no_keychain, jss_repo): 223 | args = ["--mode", "NotAMode", 224 | "--file", "coreconfig-softwareupdate-run.py", 225 | "--local-repo", jss_repo, 226 | "--name", "macad-2018-test.py", 227 | "--tag", "0.0.49", 228 | "--no-keychain"] 229 | with pytest.raises(SystemExit): 230 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 231 | out = capsys.readouterr()[0] 232 | assert out.find( 233 | """(choose from 'Script', 'ComputerExtensionAttribute')""") 234 | 235 | 236 | def test_exception_no_tag_or_branch(capsys, prefs_file_no_keychain, jss_repo): 237 | args = ["--mode", "Script", 238 | "--file", "coreconfig-softwareupdate-run.py", 239 | "--local-repo", jss_repo, 240 | "--name", "macad-2018-test.py", 241 | "--no-keychain" 242 | ] 243 | with pytest.raises(SystemExit): 244 | git2jss.main(argv=args, prefs_file=prefs_file_no_keychain()) 245 | out = capsys.readouterr()[0] 246 | assert out.find( 247 | """(Please specify with '--tag' or '--branch')""") 248 | 249 | -------------------------------------------------------------------------------- /tests/test_processors.py: -------------------------------------------------------------------------------- 1 | # --*-- encoding: utf-8 --*-- 2 | import git2jss.processors as processors 3 | import git2jss.vcs as vcs 4 | import git2jss.jss_keyring as jkc 5 | import subprocess 6 | import pytest 7 | from pytest import raises 8 | import jss 9 | 10 | @pytest.fixture(scope="session", name="a_jss") 11 | def fixture_a_jss(): 12 | # You'll need to create this file... 13 | prefs = jkc.KJSSPrefs(preferences_file='tests/com.github.gkluoe.git2jss.plist') 14 | JSS = jss.JSS(prefs) 15 | return JSS 16 | 17 | @pytest.fixture(scope="session", name="jss_repo") 18 | def fixture_jss_repo(tmpdir_factory): 19 | """ Return a valid GitRepo object """ 20 | tmp_dir = str(tmpdir_factory.mktemp('source_gitrepo')) 21 | subprocess.check_call(['git', 'clone', 'https://github.com/uoe-macos/jss', tmp_dir]) 22 | return tmp_dir 23 | 24 | 25 | @pytest.fixture(scope='session', name='a_gitrepo') 26 | def fixture_a_gitrepo(jss_repo): 27 | repo = vcs.GitRepo(tag='git2jss-test', sourcedir=jss_repo) 28 | return repo 29 | 30 | 31 | 32 | @pytest.mark.need_jss 33 | def test_new_generic_object(a_gitrepo, a_jss): 34 | """ Can we create a new Script object? """ 35 | newobj = processors.JSSObject( 36 | a_gitrepo, a_jss, 'coreconfig-softwareupdate-run.py', target='macad-2018-test.py') 37 | assert newobj 38 | 39 | @pytest.mark.need_jss 40 | def test_new_script_object(a_gitrepo, a_jss): 41 | """ Can we create a new Script object? """ 42 | newobj = processors.Script(a_gitrepo, a_jss, source_file='coreconfig-softwareupdate-run.py', 43 | target='macad-2018-test.py') 44 | assert newobj 45 | 46 | @pytest.mark.need_jss 47 | def test_new_script_object_badfile(a_gitrepo, a_jss): 48 | """ Can we create a new Script object? """ 49 | with raises(vcs.FileNotFoundError): 50 | processors.Script(a_gitrepo, a_jss, source_file='sausages', 51 | target='macad-2018-test.py') 52 | 53 | @pytest.mark.need_jss 54 | def test_new_script_object_subdirectory(a_gitrepo, a_jss): 55 | """ Can we create a new Script object? """ 56 | newobj = processors.Script(a_gitrepo, a_jss, source_file='_docs/this is a test', 57 | target='macad-2018-test.py') 58 | assert newobj 59 | 60 | @pytest.mark.need_jss 61 | def test_new_script_object_badtarget(a_gitrepo, a_jss): 62 | """ Can we create a new Script object? """ 63 | with raises(processors.TargetNotFoundError): 64 | processors.Script(a_gitrepo, a_jss, source_file='coreconfig-softwareupdate-run.py', 65 | target='foo') 66 | 67 | @pytest.mark.need_jss 68 | def test_new_cea_object(a_gitrepo, a_jss): 69 | """ Can we create a new Script object? """ 70 | newobj = processors.ComputerExtensionAttribute( 71 | a_gitrepo, a_jss, source_file='coreconfig-softwareupdate-run.py', target='test-1') 72 | assert newobj 73 | 74 | @pytest.mark.need_jss 75 | def test_update_cea_object(a_gitrepo, a_jss): 76 | """ Can we update a CEA object ? """ 77 | newobj = processors.ComputerExtensionAttribute( 78 | a_gitrepo, a_jss, source_file='coreconfig-softwareupdate-run.py', target='test-1') 79 | 80 | newobj.update() 81 | 82 | @pytest.mark.need_jss 83 | def test_save_cea_object(a_gitrepo, a_jss): 84 | """ Can we save a CEA object ? """ 85 | newobj = processors.ComputerExtensionAttribute( 86 | a_gitrepo, a_jss, source_file='coreconfig-softwareupdate-run.py', target='test-1') 87 | 88 | newobj.update() 89 | newobj.save() 90 | 91 | 92 | def test_templating(tmpdir): 93 | """ Does templating work? """ 94 | data = {'a': 'ThisIsA', 'b': 'ThisIsB', 'c': 123} 95 | 96 | handle = tmpdir.mkdir("template").join("test.txt") 97 | 98 | handle.write("@@a - @@b - @@c - @@d") 99 | 100 | out = processors.template_file(handle, data, d=u' గ ఘ ఙ చ ఛ జ ఝ ఞ ట ఠ') 101 | 102 | assert out == u'ThisIsA - ThisIsB - 123 - గ ఘ ఙ చ ఛ జ ఝ ఞ ట ఠ' 103 | 104 | -------------------------------------------------------------------------------- /tests/test_vcs.py: -------------------------------------------------------------------------------- 1 | """ Tests for the vcs module """ 2 | # --*-- encoding: utf-8 --*-- 3 | import subprocess 4 | import os 5 | import pytest 6 | from pytest import raises 7 | import git2jss.vcs as vcs 8 | import git2jss.exceptions as exceptions 9 | 10 | 11 | def _build_local_repo(test_dir, remote=None): 12 | """ Build a fresh local git repo. 13 | if `remote` is specified, add the URL 14 | to the repo as a new git remote 15 | """ 16 | subprocess.call(["git", "init", "."], 17 | cwd=test_dir) 18 | if remote: 19 | subprocess.call(["git", "remote", 20 | "add", "origin", 21 | remote], cwd=test_dir) 22 | 23 | 24 | def test_new_gitrepo_not_a_repo(tmpdir): 25 | """ Directory is not a git repo """ 26 | with raises(vcs.NotAGitRepoError): 27 | vcs.GitRepo(tag='NotATag', 28 | sourcedir=str(tmpdir)) 29 | 30 | 31 | def test_new_no_remote(tmpdir): 32 | """ Directory has no git remotes configured """ 33 | _build_local_repo(str(tmpdir)) 34 | with raises(vcs.NoRemoteError): 35 | vcs.GitRepo(tag='NotATag', 36 | sourcedir=str(tmpdir)) 37 | 38 | 39 | def test_too_many_remotes(tmpdir, git2jss_test_repo): 40 | """ Directory has too many remotes configured """ 41 | _build_local_repo(str(tmpdir), 42 | remote=git2jss_test_repo) 43 | # Add another remote 44 | subprocess.call(["git", "remote", 45 | "add", "notherone", 46 | "https://notarepo.example.com"], 47 | cwd=str(tmpdir)) 48 | 49 | with raises(vcs.TooManyRemotesError): 50 | vcs.GitRepo(tag='NotATag', 51 | sourcedir=str(tmpdir)) 52 | 53 | 54 | def test_new_no_tag_on_remote(tmpdir, git2jss_test_repo): 55 | """ Remote doesn't have our tag """ 56 | _build_local_repo(str(tmpdir), 57 | remote=git2jss_test_repo) 58 | with raises(vcs.RefNotFoundError): 59 | vcs.GitRepo(tag='NotATag', 60 | sourcedir=str(tmpdir)) 61 | 62 | def test_new_no_branch_on_remote(tmpdir, git2jss_test_repo): 63 | """ Remote doesn't have our tag """ 64 | _build_local_repo(str(tmpdir), 65 | remote=git2jss_test_repo) 66 | with raises(vcs.RefNotFoundError): 67 | vcs.GitRepo(branch='NotBranch', 68 | sourcedir=str(tmpdir)) 69 | 70 | def test_new_with_tag(gitrepo, git2jss_test_repo): 71 | """ Successfully instantiate a GitRepo """ 72 | # '.git' should have been trimmed from the repo URL 73 | assert gitrepo.remote_url == git2jss_test_repo[:-4] 74 | assert gitrepo.remote_name == "origin" 75 | assert gitrepo.tag == "test-1.0.0" 76 | 77 | 78 | def test_new_with_master(gitrepo_master, git2jss_test_repo): 79 | """ Successfully instantiate a GitRepo """ 80 | # '.git' should have been trimmed from the repo URL 81 | assert gitrepo_master.remote_url == git2jss_test_repo[:-4] 82 | assert gitrepo_master.remote_name == "origin" 83 | assert gitrepo_master.branch == "master" 84 | 85 | 86 | def test_new_with_branch001(gitrepo_branch001, git2jss_test_repo): 87 | """ Successfully instantiate a GitRepo """ 88 | # '.git' should have been trimmed from the repo URL 89 | assert gitrepo_branch001.remote_url == git2jss_test_repo[:-4] 90 | assert gitrepo_branch001.remote_name == "origin" 91 | assert gitrepo_branch001.branch == "branch001" 92 | 93 | 94 | 95 | def test_check_path_to_file(gitrepo): 96 | """ Can we return the path to a file? """ 97 | assert (gitrepo.path_to_file("README.md") == 98 | os.path.join(gitrepo.tmp_dir, 'README.md')) 99 | 100 | # Paths should come back as absolute paths 101 | assert (gitrepo.path_to_file("././././././README.md") == 102 | os.path.join(gitrepo.tmp_dir, 'README.md')) 103 | assert (gitrepo.path_to_file("././foo/../././././README.md") == 104 | os.path.join(gitrepo.tmp_dir, 'README.md')) 105 | 106 | # And of course the file should exist! 107 | assert os.path.isfile(os.path.join(gitrepo.tmp_dir, 108 | 'README.md')) 109 | 110 | 111 | def test_check_non_file_ascii(gitrepo): 112 | """ Check a non-existing file with an ascii name """ 113 | with raises(vcs.FileNotFoundError): 114 | assert gitrepo.path_to_file(u"kf/dsd/fsd/fs/sd.blah") 115 | 116 | 117 | @pytest.mark.xfail # We don't seem to support unicode filenames 118 | def test_check_non_file_unicode(gitrepo): 119 | """ Check a non-existing file with a unicode name """ 120 | with raises(vcs.FileNotFoundError): 121 | assert gitrepo.path_to_file(u"kf/dsd/⌨fsd/⌨fs/sd.blah") 122 | 123 | 124 | # def test_check_create_tag(gitrepo): 125 | # """ Check we can create a new tag """ 126 | # # We've already got a nice random string 127 | # newtag = os.path.basename(gitrepo.tmp_dir) 128 | # # Poke a new tag 129 | # oldtag = gitrepo.tag 130 | # try: 131 | # gitrepo.tag = newtag 132 | # assert not gitrepo._has_ref_on_remote(newtag) 133 | # gitrepo.create_tag(msg="Tagged by pytest") 134 | # assert gitrepo._has_tag_on_remote(newtag) 135 | # finally: 136 | # gitrepo.tag = oldtag 137 | 138 | 139 | def test_get_file_info(gitrepo): 140 | """ Test getting the git info for a known file """ 141 | filename = 'README.md' 142 | info = {'ORIGIN': 'https://github.com/gkluoe/git2jss-test', 143 | 'PATH': '{}'.format(filename), 144 | 'DATE': '"Sat Mar 17 09:14:38 2018 +0000"', 145 | 'VERSION': 'test-1.0.0', 146 | 'LOG': '371a104 - Sat, 17 Mar 2018 09:14:38 +0000 noreply@github.com: \n Initial commit'} 147 | assert gitrepo.file_info(filename) == info 148 | 149 | def test_get_file_info_branch(gitrepo_branch001): 150 | """ Test getting the git info for a known file """ 151 | filename = 'README.md' 152 | info = {'ORIGIN': 'https://github.com/gkluoe/git2jss-test', 153 | 'PATH': '{}'.format(filename), 154 | 'DATE': '"Fri Apr 5 08:54:43 2019 +0100"', 155 | 'VERSION': 'd63e87d0e695e3304d2f2a8137b1da9d88587bf4 on branch: branch001', 156 | 'LOG': ('d63e87d - Fri, 5 Apr 2019 08:54:43 +0100 g.lee@ed.ac.uk: \n Add a test branch\n\n' 157 | '371a104 - Sat, 17 Mar 2018 09:14:38 +0000 noreply@github.com: \n Initial commit')} 158 | assert gitrepo_branch001.file_info(filename) == info 159 | 160 | def test_get_file_info_notexist(gitrepo): 161 | """ Get info for a non-existing file """ 162 | filename = 'lsh/fsd/f/s/avads/fa/' 163 | with raises(vcs.FileNotFoundError): 164 | gitrepo.file_info(filename) 165 | 166 | 167 | def test_get_file(gitrepo): 168 | """ Test getting an open handle to a file """ 169 | import io 170 | filename = 'README.md' 171 | handle = gitrepo.get_file(filename) 172 | 173 | assert isinstance(handle, io.TextIOWrapper) 174 | assert handle.read() == (u'# git2jss-test\nThis exists purely to test ' 175 | 'https://github.com/gkluoe/git2jss\n') 176 | 177 | 178 | def test_error_during_checkout(gitrepo, tmpdir_factory): 179 | """ Provoke a failure during checkout """ 180 | gitrepo.remote_url = 'https://www.example.com/blah' 181 | gitrepo.tmp_dir = str(tmpdir_factory.mktemp('checkout_error')) 182 | with raises(exceptions.Git2JSSError, 183 | match=".*repository 'https://www.example.com/blah.git/' not found"): 184 | gitrepo._clone_to_tmp() 185 | --------------------------------------------------------------------------------