Mercurial > repos > fubar > tool_factory_docker
changeset 2:a5c5652823a6 draft
Uploaded
| author | fubar |
|---|---|
| date | Tue, 05 Jan 2021 00:35:40 +0000 |
| parents | 0778fb523693 |
| children | 12331d91c4ad |
| files | toolfactory/LICENSE toolfactory/README.md toolfactory/galaxy-tool-test toolfactory/rgToolFactory2.py toolfactory/rgToolFactory2.xml toolfactory/test-data/input1_sample toolfactory/test-data/output2_sample toolfactory/test-data/pyrevpos.python toolfactory/test-data/test1_log.txt toolfactory/test-data/toolfactory_pyrevpos_tgz_sample toolfactory/testtf.sh toolfactory/whoosh.sh toolfactory_docker/LICENSE toolfactory_docker/README.md toolfactory_docker/images/dynamicScriptTool.png toolfactory_docker/rgToolFactory2.py toolfactory_docker/rgToolFactory2.xml toolfactory_docker/test-data/input1_sample toolfactory_docker/test-data/output2_sample toolfactory_docker/test-data/pyrevpos.python toolfactory_docker/test-data/test1_log.txt toolfactory_docker/test-data/toolfactory_pyrevpos_tgz_sample |
| diffstat | 22 files changed, 2653 insertions(+), 3131 deletions(-) [+] |
line wrap: on
line diff
--- a/toolfactory/LICENSE Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,504 +0,0 @@ -GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -(This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.) - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - {description} - Copyright (C) {year} {fullname} - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 - USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random - Hacker. - - {signature of Ty Coon}, 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it!
--- a/toolfactory/README.md Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,211 +0,0 @@ -**Breaking news! Docker container is recommended as at August 2020** - -A Docker container can be built - see the docker directory. -It is highly recommended for isolation. It also has an integrated toolshed to allow installation of new tools back -into the Galaxy being used to generate them. - -Built from quay.io/bgruening/galaxy:20.05 but updates the -Galaxy code to the dev branch - it seems to work fine with updated bioblend>=0.14 -with planemo and the right version of gxformat2 needed by the ToolFactory (TF). - -The runclean.sh script run from the docker subdirectory of your local clone of this repository -should create a container (eventually) and serve it at localhost:8080 with a toolshed at -localhost:9009. - -Once it's up, please restart Galaxy in the container with -```docker exec [container name] supervisorctl restart galaxy: ``` -Jobs just do not seem to run properly otherwise and the next steps won't work! - -The generated container includes a workflow and 2 sample data sets for the workflow - -Load the workflow. Adjust the inputs for each as labelled. The perl example counts GC in phiX.fasta. -The python scripts use the rgToolFactory.py as their input - any text file will work but I like the -recursion. The BWA example has some mitochondrial reads and reference. Run the workflow and watch. -This should fill the history with some sample tools you can rerun and play with. -Note that each new tool will have been tested using Planemo. In the workflow, in Galaxy. -Extremely cool to watch. - -*WARNING* - - Install this tool on a throw-away private Galaxy or Docker container ONLY - Please NEVER on a public or production instance - -*Short Story* - -Galaxy is easily extended to new applications by adding a new tool. Each new scientific computational package added as -a tool to Galaxy requires some special instructions to be written. This is sometimes termed "wrapping" the package -because the instructions tell Galaxy how to run the package as a new Galaxy tool. Any tool in a Galaxy is -readily available to all the users through a consistent and easy to use interface. - -Most Galaxy tool wrappers have been manually prepared by skilled programmers, many using Planemo because it -automates much of the basic boilerplate and makes the process much easier. The ToolFactory (TF) -uses Planemo under the hood for many functions, but hides the command -line complexities from the TF user. - -*More Explanation* - -The TF is an unusual Galaxy tool, designed to allow a skilled user to make new Galaxy tools. -It appears in Galaxy just like any other tool but outputs include new Galaxy tools generated -using instructions provided by the user and the results of Planemo lint and tool testing using -small sample inputs provided by the TF user. The small samples become tests built in to the new tool. - -It offers a familiar Galaxy form driven way to define how the user of the new tool will -choose input data from their history, and what parameters the new tool user will be able to adjust. -The TF user must know, or be able to read, enough about the tool to be able to define the details of -the new Galaxy interface and the ToolFactory offers little guidance on that other than some examples. - -Tools always depend on other things. Most tools in Galaxy depend on third party -scientific packages, so TF tools usually have one or more dependencies. These can be -scientific packages such as BWA or scripting languages such as Python and are -usually managed by Conda. If the new tool relies on a system utility such as bash or awk -where the importance of version control on reproducibility is low, these can be used without -Conda management - but remember the potential risks of unmanaged dependencies on computational -reproducibility. - -The TF user can optionally supply a working script where scripting is -required and the chosen dependency is a scripting language such as Python or a system -scripting executable such as bash. Whatever the language, the script must correctly parse the command line -arguments it receives at tool execution, as they are defined by the TF user. The -text of that script is "baked in" to the new tool and will be executed each time -the new tool is run. It is highly recommended that scripts and their command lines be developed -and tested until proven to work before the TF is invoked. Galaxy as a software development -environment is actually possible, but not recommended being somewhat clumsy and inefficient. - -Tools nearly always take one or more data sets from the user's history as input. TF tools -allow the TF user to define what Galaxy datatypes the tool end user will be able to choose and what -names or positions will be used to pass them on a command line to the package or script. - -Tools often have various parameter settings. The TF allows the TF user to define how each -parameter will appear on the tool form to the end user, and what names or positions will be -used to pass them on the command line to the package. At present, parameters are limited to -simple text and number fields. Pull requests for other kinds of parameters that galaxyxml -can handle are welcomed. - -Best practice Galaxy tools have one or more automated tests. These should use small sample data sets and -specific parameter settings so when the tool is tested, the outputs can be compared with their expected -values. The TF will automatically create a test for the new tool. It will use the sample data sets -chosen by the TF user when they built the new tool. - -The TF works by exposing *unrestricted* and therefore extremely dangerous scripting -to all designated administrators of the host Galaxy server, allowing them to -run scripts in R, python, sh and perl. For this reason, a Docker container is -available to help manage the associated risks. - -*Scripting uses* - -To use a scripting language to create a new tool, you must first prepared and properly test a script. Use small sample -data sets for testing. When the script is working correctly, upload the small sample datasets -into a new history, start configuring a new ToolFactory tool, and paste the script into the script text box on the TF form. - -*Outputs* - -Once the script runs sucessfully, a new Galaxy tool that runs your script -can be generated. Select the "generate" option and supply some help text and -names. The new tool will be generated in the form of a new Galaxy datatype -*tgz* - as the name suggests, it's an archive ready to upload to a -Galaxy ToolShed as a new tool repository. - -It is also possible to run a tool to generate test outputs, then test it -using planemo. A toolshed is built in to the Docker container and configured -so a tool can be tested, sent to that toolshed, then installed in the Galaxy -where the TF is running. - -If the tool requires a command or test XML override, then planemo is -needed to generate test outputs to make a complete tool, rerun to test -and if required upload to the local toolshed and install in the Galaxy -where the TF is running. - -Once it's in a ToolShed, it can be installed into any local Galaxy server -from the server administrative interface. - -Once the new tool is installed, local users can run it - each time, the -package and/or script that was supplied when it was built will be executed with the input chosen -from the user's history, together with user supplied parameters. In other words, the tools you generate with the -ToolFactory run just like any other Galaxy tool. - -TF generated tools work as normal workflow components. - - -*Limitations* - -The TF is flexible enough to generate wrappers for many common scientific packages -but the inbuilt automation will not cope with all possible situations. Users can -supply overrides for two tool XML segments - tests and command and the BWA -example in the supplied samples workflow illustrates their use. - -*Installation* - -The Docker container is the best way to use the TF because it is preconfigured -to automate new tool testing and has a built in local toolshed where each new tool -is uploaded. If you grab the docker container, it should just work. - -If you build the container, there are some things to watch out for. Let it run for 10 minutes -or so once you build it - check with top until conda has finished fussing. Once everything quietens -down, find the container with -```docker ps``` -and use -```docker exec [containername] supervisorctl restart galaxy:``` -That colon is not a typographical mistake. -Not restarting after first boot seems to leave the job/worflow system confused and the workflow -just will not run properly until Galaxy has restarted. - -Login as admin@galaxy.org with password "password". Feel free to change it once you are logged in. -There should be a companion toolshed at localhost:9090. The history should have some sample data for -the workflow. - -Run the workflow and make sure the right dataset is selected for each of the input files. Most of the -examples use text files so should run, but the bwa example needs the right ones to work properly. - -When the workflow is finished, you will have half a dozen examples to rerun and play with. They have also -all been tested and installed so you should find them in your tool menu under "Generated Tools" - -It is easy to install without Docker, but you will need to make some -configuration changes (TODO write a configuration). You can install it most conveniently using the -administrative "Search and browse tool sheds" link. Find the Galaxy Main -toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory -repository in the Tool Maker section. Open it and review the code and select the option to install it. - -Otherwise, if not already there pending an accepted PR, -please add: -<datatype extension="tgz" type="galaxy.datatypes.binary:Binary" -mimetype="multipart/x-gzip" subclass="True" /> -to your local data_types_conf.xml. - - -*Restricted execution* - -The tool factory tool itself will then be usable ONLY by admin users - -people with IDs in admin_users. **Yes, that's right. ONLY -admin_users can run this tool** Think about it for a moment. If allowed to -run any arbitrary script on your Galaxy server, the only thing that would -impede a miscreant bent on destroying all your Galaxy data would probably -be lack of appropriate technical skills. - -**Generated tool Security** - -Once you install a generated tool, it's just -another tool - assuming the script is safe. They just run normally and their -user cannot do anything unusually insecure but please, practice safe toolshed. -Read the code before you install any tool. Especially this one - it is really scary. - -**Send Code** - -Pull requests and suggestions welcome as git issues please? - -**Attribution** - -Creating re-usable tools from scripts: The Galaxy Tool Factory -Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team -Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573 - -http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref - -**Licensing** - -Copyright Ross Lazarus 2010 -ross lazarus at g mail period com - -All rights reserved. - -Licensed under the LGPL -
--- a/toolfactory/galaxy-tool-test Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,457 +0,0 @@ -#!/usr/bin/env python - -import argparse -import datetime as dt -import json -import logging -import os -import sys -import tempfile -from collections import namedtuple -from concurrent.futures import thread, ThreadPoolExecutor - -import yaml - -from galaxy.tool_util.verify.interactor import ( - DictClientTestConfig, - GalaxyInteractorApi, - verify_tool, -) - -DESCRIPTION = """Script to quickly run a tool test against a running Galaxy instance.""" -DEFAULT_SUITE_NAME = "Galaxy Tool Tests" -ALL_TESTS = -1 -ALL_TOOLS = "*" -ALL_VERSION = "*" -LATEST_VERSION = None - - -TestReference = namedtuple("TestReference", ["tool_id", "tool_version", "test_index"]) -TestException = namedtuple("TestException", ["tool_id", "exception", "was_recorded"]) - - -class Results: - - def __init__(self, default_suitename, test_json, append=False): - self.test_json = test_json or "-" - test_results = [] - test_exceptions = [] - suitename = default_suitename - if append: - assert test_json != "-" - with open(test_json) as f: - previous_results = json.load(f) - test_results = previous_results["tests"] - if "suitename" in previous_results: - suitename = previous_results["suitename"] - self.test_results = test_results - self.test_exceptions = test_exceptions - self.suitename = suitename - - def register_result(self, result): - self.test_results.append(result) - - def register_exception(self, test_exception): - self.test_exceptions.append(test_exception) - - def already_successful(self, test_reference): - test_id = _test_id_for_reference(test_reference) - for test_result in self.test_results: - if test_result.get('id') != test_id: - continue - - has_data = test_result.get('has_data', False) - if has_data: - test_data = test_result.get("data", {}) - if 'status' in test_data and test_data['status'] == 'success': - return True - - return False - - def write(self): - tests = sorted(self.test_results, key=lambda el: el['id']) - n_passed, n_failures, n_skips = 0, 0, 0 - n_errors = len([e for e in self.test_exceptions if not e.was_recorded]) - for test in tests: - has_data = test.get('has_data', False) - if has_data: - test_data = test.get("data", {}) - if 'status' not in test_data: - raise Exception(f"Test result data {test_data} doesn't contain a status key.") - status = test_data['status'] - if status == "success": - n_passed += 1 - elif status == "error": - n_errors += 1 - elif status == "skip": - n_skips += 1 - elif status == "failure": - n_failures += 1 - report_obj = { - 'version': '0.1', - 'suitename': self.suitename, - 'results': { - 'total': n_passed + n_failures + n_skips + n_errors, - 'errors': n_errors, - 'failures': n_failures, - 'skips': n_skips, - }, - 'tests': tests, - } - if self.test_json == "-": - print(json.dumps(report_obj)) - else: - with open(self.test_json, "w") as f: - json.dump(report_obj, f) - - def info_message(self): - messages = [] - passed_tests = self._tests_with_status('success') - messages.append("Passed tool tests ({}): {}".format( - len(passed_tests), - [t["id"] for t in passed_tests] - )) - failed_tests = self._tests_with_status('failure') - messages.append("Failed tool tests ({}): {}".format( - len(failed_tests), - [t["id"] for t in failed_tests] - )) - skiped_tests = self._tests_with_status('skip') - messages.append("Skipped tool tests ({}): {}".format( - len(skiped_tests), - [t["id"] for t in skiped_tests] - )) - errored_tests = self._tests_with_status('error') - messages.append("Errored tool tests ({}): {}".format( - len(errored_tests), - [t["id"] for t in errored_tests] - )) - return "\n".join(messages) - - @property - def success_count(self): - self._tests_with_status('success') - - @property - def skip_count(self): - self._tests_with_status('skip') - - @property - def error_count(self): - return self._tests_with_status('error') + len(self.test_exceptions) - - @property - def failure_count(self): - return self._tests_with_status('failure') - - def _tests_with_status(self, status): - return [t for t in self.test_results if t.get("data", {}).get("status") == status] - - -def test_tools( - galaxy_interactor, - test_references, - results, - log=None, - parallel_tests=1, - history_per_test_case=False, - no_history_cleanup=False, - retries=0, - verify_kwds=None, -): - """Run through tool tests and write report. - - Refactor this into Galaxy in 21.01. - """ - verify_kwds = (verify_kwds or {}).copy() - tool_test_start = dt.datetime.now() - history_created = False - if history_per_test_case: - test_history = None - else: - history_created = True - test_history = galaxy_interactor.new_history(history_name=f"History for {results.suitename}") - verify_kwds.update({ - "no_history_cleanup": no_history_cleanup, - "test_history": test_history, - }) - with ThreadPoolExecutor(max_workers=parallel_tests) as executor: - try: - for test_reference in test_references: - _test_tool( - executor=executor, - test_reference=test_reference, - results=results, - galaxy_interactor=galaxy_interactor, - log=log, - retries=retries, - verify_kwds=verify_kwds, - ) - finally: - # Always write report, even if test was cancelled. - try: - executor.shutdown(wait=True) - except KeyboardInterrupt: - executor._threads.clear() - thread._threads_queues.clear() - results.write() - if log: - log.info("Report written to '%s'", os.path.abspath(results.test_json)) - log.info(results.info_message()) - log.info("Total tool test time: {}".format(dt.datetime.now() - tool_test_start)) - if history_created and not no_history_cleanup: - galaxy_interactor.delete_history(test_history) - - -def _test_id_for_reference(test_reference): - tool_id = test_reference.tool_id - tool_version = test_reference.tool_version - test_index = test_reference.test_index - - if tool_version and tool_id.endswith("/" + tool_version): - tool_id = tool_id[:-len("/" + tool_version)] - - label_base = tool_id - if tool_version: - label_base += "/" + str(tool_version) - - test_id = label_base + "-" + str(test_index) - return test_id - - -def _test_tool( - executor, - test_reference, - results, - galaxy_interactor, - log, - retries, - verify_kwds, -): - tool_id = test_reference.tool_id - tool_version = test_reference.tool_version - test_index = test_reference.test_index - # If given a tool_id with a version suffix, strip it off so we can treat tool_version - # correctly at least in client_test_config. - if tool_version and tool_id.endswith("/" + tool_version): - tool_id = tool_id[:-len("/" + tool_version)] - - test_id = _test_id_for_reference(test_reference) - - def run_test(): - run_retries = retries - job_data = None - job_exception = None - - def register(job_data_): - nonlocal job_data - job_data = job_data_ - - try: - while run_retries >= 0: - job_exception = None - try: - if log: - log.info("Executing test '%s'", test_id) - verify_tool( - tool_id, galaxy_interactor, test_index=test_index, tool_version=tool_version, - register_job_data=register, **verify_kwds - ) - if log: - log.info("Test '%s' passed", test_id) - break - except Exception as e: - if log: - log.warning("Test '%s' failed", test_id, exc_info=True) - - job_exception = e - run_retries -= 1 - finally: - if job_data is not None: - results.register_result({ - "id": test_id, - "has_data": True, - "data": job_data, - }) - if job_exception is not None: - was_recorded = job_data is not None - test_exception = TestException(tool_id, job_exception, was_recorded) - results.register_exception(test_exception) - - executor.submit(run_test) - - -def build_case_references( - galaxy_interactor, - tool_id=ALL_TOOLS, - tool_version=LATEST_VERSION, - test_index=ALL_TESTS, - page_size=0, - page_number=0, - check_against=None, - log=None, -): - test_references = [] - if tool_id == ALL_TOOLS: - tests_summary = galaxy_interactor.get_tests_summary() - for tool_id, tool_versions_dict in tests_summary.items(): - for tool_version, summary in tool_versions_dict.items(): - for test_index in range(summary["count"]): - test_reference = TestReference(tool_id, tool_version, test_index) - test_references.append(test_reference) - else: - assert tool_id - tool_test_dicts = galaxy_interactor.get_tool_tests(tool_id, tool_version=tool_version) or {} - for i, tool_test_dict in enumerate(tool_test_dicts): - this_tool_version = tool_test_dict.get("tool_version", tool_version) - this_test_index = i - if test_index == ALL_TESTS or i == test_index: - test_reference = TestReference(tool_id, this_tool_version, this_test_index) - test_references.append(test_reference) - - if check_against: - filtered_test_references = [] - for test_reference in test_references: - if check_against.already_successful(test_reference): - if log is not None: - log.debug(f"Found successful test for {test_reference}, skipping") - continue - filtered_test_references.append(test_reference) - log.info(f"Skipping {len(test_references)-len(filtered_test_references)} out of {len(test_references)} tests.") - test_references = filtered_test_references - - if page_size > 0: - slice_start = page_size * page_number - slice_end = page_size * (page_number + 1) - test_references = test_references[slice_start:slice_end] - - return test_references - - -def main(argv=None): - if argv is None: - argv = sys.argv[1:] - - args = _arg_parser().parse_args(argv) - log = setup_global_logger(__name__, verbose=args.verbose) - client_test_config_path = args.client_test_config - if client_test_config_path is not None: - log.debug(f"Reading client config path {client_test_config_path}") - with open(client_test_config_path) as f: - client_test_config = yaml.full_load(f) - else: - client_test_config = {} - - def get_option(key): - arg_val = getattr(args, key, None) - if arg_val is None and key in client_test_config: - val = client_test_config.get(key) - else: - val = arg_val - return val - - output_json_path = get_option("output_json") - galaxy_interactor_kwds = { - "galaxy_url": get_option("galaxy_url"), - "master_api_key": get_option("admin_key"), - "api_key": get_option("key"), - "keep_outputs_dir": args.output, - "download_attempts": get_option("download_attempts"), - "download_sleep": get_option("download_sleep"), - } - tool_id = args.tool_id - tool_version = args.tool_version - tools_client_test_config = DictClientTestConfig(client_test_config.get("tools")) - verbose = args.verbose - - galaxy_interactor = GalaxyInteractorApi(**galaxy_interactor_kwds) - results = Results(args.suite_name, output_json_path, append=args.append) - check_against = None if not args.skip_successful else results - test_references = build_case_references( - galaxy_interactor, - tool_id=tool_id, - tool_version=tool_version, - test_index=args.test_index, - page_size=args.page_size, - page_number=args.page_number, - check_against=check_against, - log=log, - ) - log.debug(f"Built {len(test_references)} test references to executed.") - verify_kwds = dict( - client_test_config=tools_client_test_config, - force_path_paste=args.force_path_paste, - skip_with_reference_data=not args.with_reference_data, - quiet=not verbose, - ) - test_tools( - galaxy_interactor, - test_references, - results, - log=log, - parallel_tests=args.parallel_tests, - history_per_test_case=args.history_per_test_case, - no_history_cleanup=args.no_history_cleanup, - verify_kwds=verify_kwds, - ) - exceptions = results.test_exceptions - if exceptions: - exception = exceptions[0] - if hasattr(exception, "exception"): - exception = exception.exception - raise exception - - -def setup_global_logger(name, log_file=None, verbose=False): - formatter = logging.Formatter('%(asctime)s %(levelname)-5s - %(message)s') - console = logging.StreamHandler() - console.setFormatter(formatter) - - logger = logging.getLogger(name) - logger.setLevel(logging.DEBUG if verbose else logging.INFO) - logger.addHandler(console) - - if not log_file: - # delete = false is chosen here because it is always nice to have a log file - # ready if you need to debug. Not having the "if only I had set a log file" - # moment after the fact. - temp = tempfile.NamedTemporaryFile(prefix="ephemeris_", delete=False) - log_file = temp.name - file_handler = logging.FileHandler(log_file) - logger.addHandler(file_handler) - logger.info(f"Storing log file in: {log_file}") - return logger - - -def _arg_parser(): - parser = argparse.ArgumentParser(description=DESCRIPTION) - parser.add_argument('-u', '--galaxy-url', default="http://localhost:8080", help='Galaxy URL') - parser.add_argument('-k', '--key', default=None, help='Galaxy User API Key') - parser.add_argument('-a', '--admin-key', default=None, help='Galaxy Admin API Key') - parser.add_argument('--force_path_paste', default=False, action="store_true", help='This requires Galaxy-side config option "allow_path_paste" enabled. Allows for fetching test data locally. Only for admins.') - parser.add_argument('-t', '--tool-id', default=ALL_TOOLS, help='Tool ID') - parser.add_argument('--tool-version', default=None, help='Tool Version (if tool id supplied). Defaults to just latest version, use * to test all versions') - parser.add_argument('-i', '--test-index', default=ALL_TESTS, type=int, help='Tool Test Index (starting at 0) - by default all tests will run.') - parser.add_argument('-o', '--output', default=None, help='directory to dump outputs to') - parser.add_argument('--append', default=False, action="store_true", help="Extend a test record json (created with --output-json) with additional tests.") - parser.add_argument('--skip-successful', default=False, action="store_true", help="When used with --append, skip previously run successful tests.") - parser.add_argument('-j', '--output-json', default=None, help='output metadata json') - parser.add_argument('--verbose', default=False, action="store_true", help="Verbose logging.") - parser.add_argument('-c', '--client-test-config', default=None, help="Test config YAML to help with client testing") - parser.add_argument('--suite-name', default=DEFAULT_SUITE_NAME, help="Suite name for tool test output") - parser.add_argument('--with-reference-data', dest="with_reference_data", default=False, action="store_true") - parser.add_argument('--skip-with-reference-data', dest="with_reference_data", action="store_false", help="Skip tests the Galaxy server believes use data tables or loc files.") - parser.add_argument('--history-per-suite', dest="history_per_test_case", default=False, action="store_false", help="Create new history per test suite (all tests in same history).") - parser.add_argument('--history-per-test-case', dest="history_per_test_case", action="store_true", help="Create new history per test case.") - parser.add_argument('--no-history-cleanup', default=False, action="store_true", help="Perserve histories created for testing.") - parser.add_argument('--parallel-tests', default=1, type=int, help="Parallel tests.") - parser.add_argument('--retries', default=0, type=int, help="Retry failed tests.") - parser.add_argument('--page-size', default=0, type=int, help="If positive, use pagination and just run one 'page' to tool tests.") - parser.add_argument('--page-number', default=0, type=int, help="If page size is used, run this 'page' of tests - starts with 0.") - parser.add_argument('--download-attempts', default=1, type=int, help="Galaxy may return a transient 500 status code for download if test results are written but not yet accessible.") - parser.add_argument('--download-sleep', default=1, type=int, help="If download attempts is greater than 1, the amount to sleep between download attempts.") - return parser - - -if __name__ == "__main__": - main()
--- a/toolfactory/rgToolFactory2.py Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1058 +0,0 @@ -# replace with shebang for biocontainer -# see https://github.com/fubar2/toolfactory -# -# copyright ross lazarus (ross stop lazarus at gmail stop com) May 2012 -# -# all rights reserved -# Licensed under the LGPL -# suggestions for improvement and bug fixes welcome at -# https://github.com/fubar2/toolfactory -# -# July 2020: BCC was fun and I feel like rip van winkle after 5 years. -# Decided to -# 1. Fix the toolfactory so it works - done for simplest case -# 2. Fix planemo so the toolfactory function works -# 3. Rewrite bits using galaxyxml functions where that makes sense - done -# -# uses planemo in a biodocker sort of image as a requirement -# otherwise planemo seems to leak dependencies back into the -# calling venv. Hilarity ensues. - - - -import argparse -import copy -import datetime -import grp -import json -import logging -import os -import re -import shutil -import subprocess -import sys -import tarfile -import tempfile -import time - - -from bioblend import ConnectionError -from bioblend import toolshed - -import docker - -import galaxyxml.tool as gxt -import galaxyxml.tool.parameters as gxtp - -import lxml - -import yaml - -myversion = "V2.1 July 2020" -verbose = True -debug = True -toolFactoryURL = "https://github.com/fubar2/toolfactory" -ourdelim = "~~~" - -# --input_files="$intab.input_files~~~$intab.input_CL~~~$intab.input_formats\ -#~~~$intab.input_label~~~$intab.input_help" -IPATHPOS = 0 -ICLPOS = 1 -IFMTPOS = 2 -ILABPOS = 3 -IHELPOS = 4 -IOCLPOS = 5 - -# --output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL~~~$otab.history_test" -ONAMEPOS = 0 -OFMTPOS = 1 -OCLPOS = 2 -OTESTPOS = 3 -OOCLPOS = 4 - - -# --additional_parameters="$i.param_name~~~$i.param_value~~~ -# $i.param_label~~~$i.param_help~~~$i.param_type~~~$i.CL~~~i$.param_CLoverride" -ANAMEPOS = 0 -AVALPOS = 1 -ALABPOS = 2 -AHELPPOS = 3 -ATYPEPOS = 4 -ACLPOS = 5 -AOVERPOS = 6 -AOCLPOS = 7 - - -foo = len(lxml.__version__) -# fug you, flake8. Say my name! -FAKEEXE = "~~~REMOVE~~~ME~~~" -# need this until a PR/version bump to fix galaxyxml prepending the exe even -# with override. - - -def timenow(): - """return current time as a string""" - return time.strftime("%d/%m/%Y %H:%M:%S", time.localtime(time.time())) - - -def quote_non_numeric(s): - """return a prequoted string for non-numerics - useful for perl and Rscript parameter passing? - """ - try: - _ = float(s) - return s - except ValueError: - return '"%s"' % s - - -html_escape_table = {"&": "&", ">": ">", "<": "<", "$": r"\$","#":"#", "$":"$"} -cheetah_escape_table = {"$": "\$","#":"\#"} - -def html_escape(text): - """Produce entities within text.""" - return "".join([html_escape_table.get(c, c) for c in text]) - -def cheetah_escape(text): - """Produce entities within text.""" - return "".join([cheetah_escape_table.get(c, c) for c in text]) - - -def html_unescape(text): - """Revert entities within text. Multiple character targets so use replace""" - t = text.replace("&", "&") - t = t.replace(">", ">") - t = t.replace("<", "<") - t = t.replace("\\$", "$") - t = t.replace("$","$") - t = t.replace("#","#") - return t - - -def parse_citations(citations_text): - """""" - citations = [c for c in citations_text.split("**ENTRY**") if c.strip()] - citation_tuples = [] - for citation in citations: - if citation.startswith("doi"): - citation_tuples.append(("doi", citation[len("doi") :].strip())) - else: - citation_tuples.append(("bibtex", citation[len("bibtex") :].strip())) - return citation_tuples - - -class ScriptRunner: - """Wrapper for an arbitrary script - uses galaxyxml - - """ - - def __init__(self, args=None): - """ - prepare command line cl for running the tool here - and prepare elements needed for galaxyxml tool generation - """ - self.ourcwd = os.getcwd() - self.ourenv = copy.deepcopy(os.environ) - self.infiles = [x.split(ourdelim) for x in args.input_files] - self.outfiles = [x.split(ourdelim) for x in args.output_files] - self.addpar = [x.split(ourdelim) for x in args.additional_parameters] - self.args = args - self.cleanuppar() - self.lastclredirect = None - self.lastxclredirect = None - self.cl = [] - self.xmlcl = [] - self.is_positional = self.args.parampass == "positional" - if self.args.sysexe: - self.executeme = self.args.sysexe - else: - if self.args.packages: - self.executeme = self.args.packages.split(",")[0].split(":")[0] - else: - self.executeme = None - aCL = self.cl.append - aXCL = self.xmlcl.append - assert args.parampass in [ - "0", - "argparse", - "positional", - ], 'args.parampass must be "0","positional" or "argparse"' - self.tool_name = re.sub("[^a-zA-Z0-9_]+", "", args.tool_name) - self.tool_id = self.tool_name - self.newtool = gxt.Tool( - self.tool_name, - self.tool_id, - self.args.tool_version, - self.args.tool_desc, - FAKEEXE, - ) - self.newtarpath = "toolfactory_%s.tgz" % self.tool_name - self.tooloutdir = "./tfout" - self.repdir = "./TF_run_report_tempdir" - self.testdir = os.path.join(self.tooloutdir, "test-data") - if not os.path.exists(self.tooloutdir): - os.mkdir(self.tooloutdir) - if not os.path.exists(self.testdir): - os.mkdir(self.testdir) - if not os.path.exists(self.repdir): - os.mkdir(self.repdir) - self.tinputs = gxtp.Inputs() - self.toutputs = gxtp.Outputs() - self.testparam = [] - if self.args.script_path: - self.prepScript() - if self.args.command_override: - scos = open(self.args.command_override, "r").readlines() - self.command_override = [x.rstrip() for x in scos] - else: - self.command_override = None - if self.args.test_override: - stos = open(self.args.test_override, "r").readlines() - self.test_override = [x.rstrip() for x in stos] - else: - self.test_override = None - if self.args.cl_prefix: # DIY CL start - clp = self.args.cl_prefix.split(" ") - for c in clp: - aCL(c) - aXCL(c) - else: - if self.args.script_path: - aCL(self.executeme) - aCL(self.sfile) - aXCL(self.executeme) - aXCL("$runme") - else: - aCL(self.executeme) - aXCL(self.executeme) - self.elog = os.path.join(self.repdir, "%s_error_log.txt" % self.tool_name) - self.tlog = os.path.join(self.repdir, "%s_runner_log.txt" % self.tool_name) - - if self.args.parampass == "0": - self.clsimple() - else: - clsuffix = [] - xclsuffix = [] - for i, p in enumerate(self.infiles): - if p[IOCLPOS] == "STDIN": - appendme = [ - p[IOCLPOS], - p[ICLPOS], - p[IPATHPOS], - "< %s" % p[IPATHPOS], - ] - xappendme = [ - p[IOCLPOS], - p[ICLPOS], - p[IPATHPOS], - "< $%s" % p[ICLPOS], - ] - else: - appendme = [p[IOCLPOS], p[ICLPOS], p[IPATHPOS], ""] - xappendme = [p[IOCLPOS], p[ICLPOS], "$%s" % p[ICLPOS], ""] - clsuffix.append(appendme) - xclsuffix.append(xappendme) - for i, p in enumerate(self.outfiles): - if p[OOCLPOS] == "STDOUT": - self.lastclredirect = [">", p[ONAMEPOS]] - self.lastxclredirect = [">", "$%s" % p[OCLPOS]] - else: - clsuffix.append([p[ONAMEPOS], p[ONAMEPOS], p[ONAMEPOS], ""]) - xclsuffix.append([p[ONAMEPOS], p[ONAMEPOS], "$%s" % p[ONAMEPOS], ""]) - for p in self.addpar: - clsuffix.append([p[AOCLPOS], p[ACLPOS], p[AVALPOS], p[AOVERPOS]]) - xclsuffix.append( - [p[AOCLPOS], p[ACLPOS], '"$%s"' % p[ANAMEPOS], p[AOVERPOS]] - ) - clsuffix.sort() - xclsuffix.sort() - self.xclsuffix = xclsuffix - self.clsuffix = clsuffix - if self.args.parampass == "positional": - self.clpositional() - else: - self.clargparse() - - def prepScript(self): - rx = open(self.args.script_path, "r").readlines() - rx = [x.rstrip() for x in rx] - rxcheck = [x.strip() for x in rx if x.strip() > ""] - assert len(rxcheck) > 0, "Supplied script is empty. Cannot run" - self.script = "\n".join(rx) - fhandle, self.sfile = tempfile.mkstemp( - prefix=self.tool_name, suffix="_%s" % (self.executeme) - ) - tscript = open(self.sfile, "w") - tscript.write(self.script) - tscript.close() - self.escapedScript = [cheetah_escape(x) for x in rx] - self.spacedScript = [f" {x}" for x in rx if x.strip() > ""] - art = "%s.%s" % (self.tool_name, self.executeme) - artifact = open(art, "wb") - artifact.write(bytes('\n'.join(self.escapedScript),'utf8')) - artifact.close() - - def cleanuppar(self): - """ positional parameters are complicated by their numeric ordinal""" - for i, p in enumerate(self.infiles): - infp = copy.copy(p) - if self.args.parampass == "positional": - assert infp[ - ICLPOS - ].isdigit(), "Positional parameters must be ordinal integers - got %s for %s" % ( - infp[ICLPOS], - infp[ILABPOS], - ) - icl = infp[ICLPOS] - infp.append(icl) - if infp[ICLPOS].isdigit() or self.args.parampass == "0": - scl = "input%d" % (i + 1) - infp[ICLPOS] = scl - self.infiles[i] = infp - for i, p in enumerate( - self.outfiles - ): - if self.args.parampass == "positional" and p[OCLPOS].upper() != "STDOUT": - assert p[ - OCLPOS - ].isdigit(), "Positional parameters must be ordinal integers - got %s for %s" % ( - p[OCLPOS], - p[ONAMEPOS], - ) - p.append(p[OCLPOS]) # keep copy - if p[OOCLPOS].isdigit() or p[OOCLPOS].upper() == "STDOUT": - scl = p[ONAMEPOS] - p[OCLPOS] = scl - self.outfiles[i] = p - for i, p in enumerate(self.addpar): - if self.args.parampass == "positional": - assert p[ - ACLPOS - ].isdigit(), "Positional parameters must be ordinal integers - got %s for %s" % ( - p[ACLPOS], - p[ANAMEPOS], - ) - p.append(p[ACLPOS]) - if p[ACLPOS].isdigit(): - scl = "input%s" % p[ACLPOS] - p[ACLPOS] = scl - self.addpar[i] = p - - def clsimple(self): - """no parameters - uses < and > for i/o""" - aCL = self.cl.append - aXCL = self.xmlcl.append - - if len(self.infiles) > 0: - aCL("<") - aCL(self.infiles[0][IPATHPOS]) - aXCL("<") - aXCL("$%s" % self.infiles[0][ICLPOS]) - if len(self.outfiles) > 0: - aCL(">") - aCL(self.outfiles[0][OCLPOS]) - aXCL(">") - aXCL("$%s" % self.outfiles[0][ONAMEPOS]) - - def clpositional(self): - # inputs in order then params - aCL = self.cl.append - for (o_v, k, v, koverride) in self.clsuffix: - if " " in v: - aCL("%s" % v) - else: - aCL(v) - aXCL = self.xmlcl.append - for (o_v, k, v, koverride) in self.xclsuffix: - aXCL(v) - if self.lastxclredirect: - aXCL(self.lastxclredirect[0]) - aXCL(self.lastxclredirect[1]) - - - def clargparse(self): - """argparse style""" - aCL = self.cl.append - aXCL = self.xmlcl.append - # inputs then params in argparse named form - - for (o_v, k, v, koverride) in self.xclsuffix: - if koverride > "": - k = koverride - elif len(k.strip()) == 1: - k = "-%s" % k - else: - k = "--%s" % k - aXCL(k) - aXCL(v) - for (o_v, k, v, koverride) in self.clsuffix: - if koverride > "": - k = koverride - elif len(k.strip()) == 1: - k = "-%s" % k - else: - k = "--%s" % k - aCL(k) - aCL(v) - - - def getNdash(self, newname): - if self.is_positional: - ndash = 0 - else: - ndash = 2 - if len(newname) < 2: - ndash = 1 - return ndash - - def doXMLparam(self): - """flake8 made me do this...""" - for p in self.outfiles: # --output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL~~~$otab.history_test" - newname, newfmt, newcl, test, oldcl = p - test = test.strip() - ndash = self.getNdash(newcl) - aparm = gxtp.OutputData(name=newname, format=newfmt, num_dashes=ndash, label=newcl) - aparm.positional = self.is_positional - if self.is_positional: - if oldcl.upper() == "STDOUT": - aparm.positional = 9999999 - aparm.command_line_override = "> $%s" % newname - else: - aparm.positional = int(oldcl) - aparm.command_line_override = "$%s" % newname - self.toutputs.append(aparm) - ld = None - if test.strip() > "": - if test.startswith("diff"): - c = "diff" - ld = 0 - if test.split(":")[1].isdigit: - ld = int(test.split(":")[1]) - tp = gxtp.TestOutput( - name=newcl, - value="%s_sample" % newcl, - format=newfmt, - compare= c, - lines_diff=ld, - ) - elif test.startswith("sim_size"): - c = "sim_size" - tn = test.split(":")[1].strip() - if tn > '': - if '.' in tn: - delta = None - delta_frac = min(1.0,float(tn)) - else: - delta = int(tn) - delta_frac = None - tp = gxtp.TestOutput( - name=newcl, - value="%s_sample" % newcl, - format=newfmt, - compare= c, - delta = delta, - delta_frac = delta_frac - ) - self.testparam.append(tp) - for p in self.infiles: - newname = p[ICLPOS] - newfmt = p[IFMTPOS] - ndash = self.getNdash(newname) - if not len(p[ILABPOS]) > 0: - alab = p[ICLPOS] - else: - alab = p[ILABPOS] - aninput = gxtp.DataParam( - newname, - optional=False, - label=alab, - help=p[IHELPOS], - format=newfmt, - multiple=False, - num_dashes=ndash, - ) - aninput.positional = self.is_positional - self.tinputs.append(aninput) - tparm = gxtp.TestParam(name=newname, value="%s_sample" % newname) - self.testparam.append(tparm) - for p in self.addpar: - newname, newval, newlabel, newhelp, newtype, newcl, override, oldcl = p - if not len(newlabel) > 0: - newlabel = newname - ndash = self.getNdash(newname) - if newtype == "text": - aparm = gxtp.TextParam( - newname, - label=newlabel, - help=newhelp, - value=newval, - num_dashes=ndash, - ) - elif newtype == "integer": - aparm = gxtp.IntegerParam( - newname, - label=newname, - help=newhelp, - value=newval, - num_dashes=ndash, - ) - elif newtype == "float": - aparm = gxtp.FloatParam( - newname, - label=newname, - help=newhelp, - value=newval, - num_dashes=ndash, - ) - else: - raise ValueError( - 'Unrecognised parameter type "%s" for\ - additional parameter %s in makeXML' - % (newtype, newname) - ) - aparm.positional = self.is_positional - if self.is_positional: - aparm.positional = int(oldcl) - self.tinputs.append(aparm) - tparm = gxtp.TestParam(newname, value=newval) - self.testparam.append(tparm) - - def doNoXMLparam(self): - """filter style package - stdin to stdout""" - if len(self.infiles) > 0: - alab = self.infiles[0][ILABPOS] - if len(alab) == 0: - alab = self.infiles[0][ICLPOS] - max1s = ( - "Maximum one input if parampass is 0 but multiple input files supplied - %s" - % str(self.infiles) - ) - assert len(self.infiles) == 1, max1s - newname = self.infiles[0][ICLPOS] - aninput = gxtp.DataParam( - newname, - optional=False, - label=alab, - help=self.infiles[0][IHELPOS], - format=self.infiles[0][IFMTPOS], - multiple=False, - num_dashes=0, - ) - aninput.command_line_override = "< $%s" % newname - aninput.positional = self.is_positional - self.tinputs.append(aninput) - tp = gxtp.TestParam(name=newname, value="%s_sample" % newname) - self.testparam.append(tp) - if len(self.outfiles) > 0: - newname = self.outfiles[0][OCLPOS] - newfmt = self.outfiles[0][OFMTPOS] - anout = gxtp.OutputData(newname, format=newfmt, num_dashes=0) - anout.command_line_override = "> $%s" % newname - anout.positional = self.is_positional - self.toutputs.append(anout) - tp = gxtp.TestOutput( - name=newname, value="%s_sample" % newname, format=newfmt - ) - self.testparam.append(tp) - - def makeXML(self): - """ - Create a Galaxy xml tool wrapper for the new script - Uses galaxyhtml - Hmmm. How to get the command line into correct order... - """ - if self.command_override: - self.newtool.command_override = self.command_override # config file - else: - self.newtool.command_override = self.xmlcl - if self.args.help_text: - helptext = open(self.args.help_text, "r").readlines() - safertext = "\n".join([cheetah_escape(x) for x in helptext]) - if self.args.script_path: - scr = [x for x in self.spacedScript if x.strip() > ""] - scr.insert(0,'\n------\n\n\nScript::\n') - if len(scr) > 300: - scr = ( - scr[:100] - + [" >300 lines - stuff deleted", " ......"] - + scr[-100:] - ) - scr.append('\n') - safertext = safertext + "\n".join(scr) - self.newtool.help = safertext - else: - self.newtool.help = ( - "Please ask the tool author (%s) for help \ - as none was supplied at tool generation\n" - % (self.args.user_email) - ) - self.newtool.version_command = None # do not want - requirements = gxtp.Requirements() - if self.args.packages: - for d in self.args.packages.split(","): - ver = '' - d = d.replace('==',':') - d = d.replace('=',':') - if ":" in d: - packg, ver = d.split(":") - else: - packg = d - requirements.append( - gxtp.Requirement("package", packg.strip(), ver.strip()) - ) - self.newtool.requirements = requirements - if self.args.parampass == "0": - self.doNoXMLparam() - else: - self.doXMLparam() - self.newtool.outputs = self.toutputs - self.newtool.inputs = self.tinputs - if self.args.script_path: - configfiles = gxtp.Configfiles() - configfiles.append(gxtp.Configfile(name="runme", text="\n".join(self.escapedScript))) - self.newtool.configfiles = configfiles - tests = gxtp.Tests() - test_a = gxtp.Test() - for tp in self.testparam: - test_a.append(tp) - tests.append(test_a) - self.newtool.tests = tests - self.newtool.add_comment( - "Created by %s at %s using the Galaxy Tool Factory." - % (self.args.user_email, timenow()) - ) - self.newtool.add_comment("Source in git at: %s" % (toolFactoryURL)) - self.newtool.add_comment( - "Cite: Creating re-usable tools from scripts doi:10.1093/bioinformatics/bts573" - ) - exml0 = self.newtool.export() - exml = exml0.replace(FAKEEXE, "") # temporary work around until PR accepted - if ( - self.test_override - ): # cannot do this inside galaxyxml as it expects lxml objects for tests - part1 = exml.split("<tests>")[0] - part2 = exml.split("</tests>")[1] - fixed = "%s\n%s\n%s" % (part1, self.test_override, part2) - exml = fixed - #exml = exml.replace('range="1:"', 'range="1000:"') - xf = open("%s.xml" % self.tool_name, "w") - xf.write(exml) - xf.write("\n") - xf.close() - # ready for the tarball - - def run(self): - """ - generate test outputs by running a command line - won't work if command or test override in play - planemo is the - easiest way to generate test outputs for that case so is - automagically selected - """ - scl = " ".join(self.cl) - err = None - if self.args.parampass != "0": - if os.path.exists(self.elog): - ste = open(self.elog, "a") - else: - ste = open(self.elog, "w") - if self.lastclredirect: - sto = open(self.lastclredirect[1], "wb") # is name of an output file - else: - if os.path.exists(self.tlog): - sto = open(self.tlog, "a") - else: - sto = open(self.tlog, "w") - sto.write( - "## Executing Toolfactory generated command line = %s\n" % scl - ) - sto.flush() - subp = subprocess.run( - self.cl, env=self.ourenv, shell=False, stdout=sto, stderr=ste - ) - sto.close() - ste.close() - retval = subp.returncode - else: # work around special case - stdin and write to stdout - if len(self.infiles) > 0: - sti = open(self.infiles[0][IPATHPOS], "rb") - else: - sti = sys.stdin - if len(self.outfiles) > 0: - sto = open(self.outfiles[0][ONAMEPOS], "wb") - else: - sto = sys.stdout - subp = subprocess.run( - self.cl, env=self.ourenv, shell=False, stdout=sto, stdin=sti - ) - sto.write("## Executing Toolfactory generated command line = %s\n" % scl) - retval = subp.returncode - sto.close() - sti.close() - if os.path.isfile(self.tlog) and os.stat(self.tlog).st_size == 0: - os.unlink(self.tlog) - if os.path.isfile(self.elog) and os.stat(self.elog).st_size == 0: - os.unlink(self.elog) - if retval != 0 and err: # problem - sys.stderr.write(err) - logging.debug("run done") - return retval - - def copy_to_container(self, src, dest, container): - """Recreate the src directory tree at dest - full path included""" - idir = os.getcwd() - workdir = os.path.dirname(src) - os.chdir(workdir) - _, tfname = tempfile.mkstemp(suffix=".tar") - tar = tarfile.open(tfname, mode="w") - srcb = os.path.basename(src) - tar.add(srcb) - tar.close() - data = open(tfname, "rb").read() - container.put_archive(dest, data) - os.unlink(tfname) - os.chdir(idir) - - def copy_from_container(self, src, dest, container): - """recreate the src directory tree at dest using docker sdk""" - os.makedirs(dest, exist_ok=True) - _, tfname = tempfile.mkstemp(suffix=".tar") - tf = open(tfname, "wb") - bits, stat = container.get_archive(src) - for chunk in bits: - tf.write(chunk) - tf.close() - tar = tarfile.open(tfname, "r") - tar.extractall(dest) - tar.close() - os.unlink(tfname) - - def planemo_biodocker_test(self): - """planemo currently leaks dependencies if used in the same container and gets unhappy after a - first successful run. https://github.com/galaxyproject/planemo/issues/1078#issuecomment-731476930 - - Docker biocontainer has planemo with caches filled to save repeated downloads - - - """ - - def prun(container, tout, cl, user="biodocker"): - rlog = container.exec_run(cl, user=user) - slogl = str(rlog).split("\\n") - slog = "\n".join(slogl) - tout.write(f"## got rlog {slog} from {cl}\n") - - if os.path.exists(self.tlog): - tout = open(self.tlog, "a") - else: - tout = open(self.tlog, "w") - planemoimage = "quay.io/fubar2/planemo-biocontainer" - xreal = "%s.xml" % self.tool_name - repname = f"{self.tool_name}_planemo_test_report.html" - ptestrep_path = os.path.join(self.repdir, repname) - tool_name = self.tool_name - client = docker.from_env() - tvol = client.volumes.create() - tvolname = tvol.name - destdir = "/toolfactory/ptest" - imrep = os.path.join(destdir, repname) - # need to keep the container running so keep it open with sleep - # will stop and destroy it when we are done - container = client.containers.run( - planemoimage, - "sleep 120m", - detach=True, - user="biodocker", - volumes={f"{tvolname}": {"bind": "/toolfactory", "mode": "rw"}}, - ) - cl = f"mkdir -p {destdir}" - prun(container, tout, cl, user="root") - # that's how hard it is to get root on a biodocker container :( - cl = f"rm -rf {destdir}/*" - prun(container, tout, cl, user="root") - ptestpath = os.path.join(destdir, "tfout", xreal) - self.copy_to_container(self.tooloutdir, destdir, container) - cl = "chown -R biodocker /toolfactory" - prun(container, tout, cl, user="root") - rlog = container.exec_run(f"ls -la {destdir}") - ptestcl = f"planemo test --update_test_data --no_cleanup --test_data {destdir}/tfout/test-data --galaxy_root /home/biodocker/galaxy-central {ptestpath}" - try: - rlog = container.exec_run(ptestcl) - # fails because test outputs missing but updates the test-data directory - except: - e = sys.exc_info()[0] - tout.write(f"#### error: {e} from {ptestcl}\n") - cl = f"planemo test --test_output {imrep} --no_cleanup --test_data {destdir}/tfout/test-data --galaxy_root /home/biodocker/galaxy-central {ptestpath}" - try: - prun(container, tout, cl) - except: - e = sys.exc_info()[0] - tout.write(f"#### error: {e} from {ptestcl}\n") - testouts = tempfile.mkdtemp(suffix=None, prefix="tftemp", dir=".") - self.copy_from_container(destdir, testouts, container) - src = os.path.join(testouts, "ptest") - if os.path.isdir(src): - shutil.copytree(src, ".", dirs_exist_ok=True) - src = repname - if os.path.isfile(repname): - shutil.copyfile(src, ptestrep_path) - else: - tout.write(f"No output from run to shutil.copytree in {src}\n") - tout.close() - container.stop() - container.remove() - tvol.remove() - shutil.rmtree(testouts) # leave for debugging - - def shedLoad(self): - """ - use bioblend to create new repository - or update existing - - """ - if os.path.exists(self.tlog): - sto = open(self.tlog, "a") - else: - sto = open(self.tlog, "w") - - ts = toolshed.ToolShedInstance( - url=self.args.toolshed_url, key=self.args.toolshed_api_key, verify=False - ) - repos = ts.repositories.get_repositories() - rnames = [x.get("name", "?") for x in repos] - rids = [x.get("id", "?") for x in repos] - tfcat = "ToolFactory generated tools" - if self.tool_name not in rnames: - tscat = ts.categories.get_categories() - cnames = [x.get("name", "?").strip() for x in tscat] - cids = [x.get("id", "?") for x in tscat] - catID = None - if tfcat.strip() in cnames: - ci = cnames.index(tfcat) - catID = cids[ci] - res = ts.repositories.create_repository( - name=self.args.tool_name, - synopsis="Synopsis:%s" % self.args.tool_desc, - description=self.args.tool_desc, - type="unrestricted", - remote_repository_url=self.args.toolshed_url, - homepage_url=None, - category_ids=catID, - ) - tid = res.get("id", None) - sto.write(f"#create_repository {self.args.tool_name} tid={tid} res={res}\n") - else: - i = rnames.index(self.tool_name) - tid = rids[i] - try: - res = ts.repositories.update_repository( - id=tid, tar_ball_path=self.newtarpath, commit_message=None - ) - sto.write(f"#update res id {id} ={res}\n") - except ConnectionError: - sto.write( - "####### Is the toolshed running and the API key correct? Bioblend shed upload failed\n" - ) - sto.close() - - def eph_galaxy_load(self): - """ - use ephemeris to load the new tool from the local toolshed after planemo uploads it - """ - if os.path.exists(self.tlog): - tout = open(self.tlog, "a") - else: - tout = open(self.tlog, "w") - cll = [ - "shed-tools", - "install", - "-g", - self.args.galaxy_url, - "--latest", - "-a", - self.args.galaxy_api_key, - "--name", - self.tool_name, - "--owner", - "fubar", - "--toolshed", - self.args.toolshed_url, - "--section_label", - "ToolFactory", - ] - tout.write("running\n%s\n" % " ".join(cll)) - subp = subprocess.run( - cll, env=self.ourenv, cwd=self.ourcwd, shell=False, stderr=tout, stdout=tout - ) - tout.write( - "installed %s - got retcode %d\n" % (self.tool_name, subp.returncode) - ) - tout.close() - return subp.returncode - - - - def writeShedyml(self): - """for planemo""" - yuser = self.args.user_email.split("@")[0] - yfname = os.path.join(self.tooloutdir, ".shed.yml") - yamlf = open(yfname, "w") - odict = { - "name": self.tool_name, - "owner": yuser, - "type": "unrestricted", - "description": self.args.tool_desc, - "synopsis": self.args.tool_desc, - "category": "TF Generated Tools", - } - yaml.dump(odict, yamlf, allow_unicode=True) - yamlf.close() - - def makeTool(self): - """write xmls and input samples into place""" - self.makeXML() - if self.args.script_path: - stname = os.path.join(self.tooloutdir, "%s" % (self.sfile)) - if not os.path.exists(stname): - shutil.copyfile(self.sfile, stname) - xreal = "%s.xml" % self.tool_name - xout = os.path.join(self.tooloutdir, xreal) - shutil.copyfile(xreal, xout) - for p in self.infiles: - pth = p[IPATHPOS] - dest = os.path.join(self.testdir, "%s_sample" % p[ICLPOS]) - shutil.copyfile(pth, dest) - - def makeToolTar(self): - """move outputs into test-data and prepare the tarball""" - excludeme = "_planemo_test_report.html" - - def exclude_function(tarinfo): - filename = tarinfo.name - return None if filename.endswith(excludeme) else tarinfo - - if os.path.exists(self.tlog): - tout = open(self.tlog, "a") - else: - tout = open(self.tlog, "w") - for p in self.outfiles: - oname = p[ONAMEPOS] - tdest = os.path.join(self.testdir, "%s_sample" % oname) - if not os.path.isfile(tdest): - src = os.path.join(self.testdir, oname) - if os.path.isfile(src): - shutil.copyfile(src, tdest) - dest = os.path.join(self.repdir, "%s.sample" % (oname)) - shutil.copyfile(src, dest) - else: - tout.write( - "###Output file %s not found in testdir %s. This is normal during the first Planemo run that generates test outputs" - % (tdest, self.testdir) - ) - tf = tarfile.open(self.newtarpath, "w:gz") - tf.add(name=self.tooloutdir, arcname=self.tool_name, filter=exclude_function) - tf.close() - shutil.copyfile(self.newtarpath, self.args.new_tool) - - def moveRunOutputs(self): - """need to move planemo or run outputs into toolfactory collection""" - with os.scandir(self.tooloutdir) as outs: - for entry in outs: - if not entry.is_file(): - continue - if "." in entry.name: - nayme, ext = os.path.splitext(entry.name) - if ext in [".yml", ".xml", ".json", ".yaml"]: - ext = f"{ext}.txt" - else: - ext = ".txt" - ofn = "%s%s" % (entry.name.replace(".", "_"), ext) - dest = os.path.join(self.repdir, ofn) - src = os.path.join(self.tooloutdir, entry.name) - shutil.copyfile(src, dest) - with os.scandir(self.testdir) as outs: - for entry in outs: - if ( - (not entry.is_file()) - or entry.name.endswith("_sample") - or entry.name.endswith("_planemo_test_report.html") - ): - continue - if "." in entry.name: - nayme, ext = os.path.splitext(entry.name) - else: - ext = ".txt" - newname = f"{entry.name}{ext}" - dest = os.path.join(self.repdir, newname) - src = os.path.join(self.testdir, entry.name) - shutil.copyfile(src, dest) - - -def main(): - """ - This is a Galaxy wrapper. It expects to be called by a special purpose tool.xml - - """ - parser = argparse.ArgumentParser() - a = parser.add_argument - a("--script_path", default=None) - a("--history_test", default=None) - a("--cl_prefix", default=None) - a("--sysexe", default=None) - a("--packages", default=None) - a("--tool_name", default="newtool") - a("--tool_dir", default=None) - a("--input_files", default=[], action="append") - a("--output_files", default=[], action="append") - a("--user_email", default="Unknown") - a("--bad_user", default=None) - a("--make_Tool", default="runonly") - a("--help_text", default=None) - a("--tool_desc", default=None) - a("--tool_version", default=None) - a("--citations", default=None) - a("--command_override", default=None) - a("--test_override", default=None) - a("--additional_parameters", action="append", default=[]) - a("--edit_additional_parameters", action="store_true", default=False) - a("--parampass", default="positional") - a("--tfout", default="./tfout") - a("--new_tool", default="new_tool") - a("--galaxy_url", default="http://localhost:8080") - a("--toolshed_url", default="http://localhost:9009") - # make sure this is identical to tool_sheds_conf.xml localhost != 127.0.0.1 so validation fails - a("--toolshed_api_key", default="fakekey") - a("--galaxy_api_key", default="fakekey") - a("--galaxy_root", default="/galaxy-central") - a("--galaxy_venv", default="/galaxy_venv") - args = parser.parse_args() - assert not args.bad_user, ( - 'UNAUTHORISED: %s is NOT authorized to use this tool until Galaxy admin adds %s to "admin_users" in the galaxy.yml Galaxy configuration file' - % (args.bad_user, args.bad_user) - ) - assert args.tool_name, "## Tool Factory expects a tool name - eg --tool_name=DESeq" - assert ( - args.sysexe or args.packages - ), "## Tool Factory wrapper expects an interpreter or an executable package" - args.input_files = [x.replace('"', "").replace("'", "") for x in args.input_files] - # remove quotes we need to deal with spaces in CL params - for i, x in enumerate(args.additional_parameters): - args.additional_parameters[i] = args.additional_parameters[i].replace('"', "") - r = ScriptRunner(args) - r.writeShedyml() - r.makeTool() - if args.make_Tool == "generate": - retcode = r.run() # for testing toolfactory itself - r.moveRunOutputs() - r.makeToolTar() - else: - r.planemo_biodocker_test() # test to make outputs and then test - r.moveRunOutputs() - r.makeToolTar() - if args.make_Tool == "gentestinstall": - r.shedLoad() - r.eph_galaxy_load() - - -if __name__ == "__main__": - main()
--- a/toolfactory/rgToolFactory2.xml Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,538 +0,0 @@ -<tool id="rgtfd" name="toolfactory" version="2.00" profile="16.04" > - <description>Scripts into tools v2.0</description> - <macros> - <xml name="tool_metadata"> - <param name="tool_version" label="Tool Version - bump this to warn users trying to redo old analyses" type="text" value="0.01" - help="If you change your script and regenerate the 'same' tool, you should inform Galaxy (and users) by changing (bumping is traditional) this number"/> - <param name="tool_desc" label="Tool Synopsis" type="text" value="" - help="Supply a brief tool description for the Galaxy tool menu entry" /> - <param name="help_text" label="Tool form documentation and help text for users" type="text" area="true" - value="**What it Does**" - help="Supply user documentation to appear on the new tool form as reStructured text - http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html" > - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <repeat name="citations" title="Citation"> - <conditional name="citation_type"> - <param name="type" type="select" display="radio" label="Citation Type"> - <option value="doi">DOI</option> - <option value="bibtex">BibTeX</option> - </param> - <when value="doi"> - <param name="doi" label="DOI" type="text" value="" - help="Supply a DOI (e.g. doi: 10.1111/j.1740-9713.2007.00258.x) to be cited when this tool is used in published research." /> - </when> - <when value="bibtex"> - <param name="bibtex" label="BibTex" type="text" area="true" - help="Supply a BibTex entry that should be cited when this tool is used in published research." value="" > - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - </when> - </conditional> - </repeat> - </xml> - <xml name="io"> - <section name="io" title="Input and output files" expanded="true"> - <repeat name="history_inputs" title="zero or more input data files to pass as parameters to the executable." - help="USE SMALL SAMPLES for the new tool's test. Prompts will form a history item selector as input for users of this new tool"> - <param name="input_files" type="data" format="data" label="Select an input file from your history" optional="true" multiple="false" - help=""/> - <param name="input_formats" type="select" multiple="true" label="Select the datatype(s) that your tool/script accepts as input" - help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular"> - <options from_parameter="tool.app.datatypes_registry.upload_file_formats"> - <column name="value" index="0"/> - </options> - </param> - <param name="input_label" type="text" value="" label="This will become the user prompt for the form so please make it informative" - help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" > - <sanitizer invalid_char=""> - <valid initial="string.printable"> <remove value='~~~'/> </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="input_help" type="text" value="" label="This will become help text on the form." - help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation"> - <sanitizer invalid_char=""> - <valid initial="string.printable"> <remove value='~~~'/> </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="input_CL" type="text" label="Positional: ordinal integer. Argparse: argument name. STDIN if the executable/script expects it" - help="If you will pass positional parameters, enter the integer ordinal for this parameter. If Argparse style, '--' will be prepended or '-' if single character" value=""> - </param> - </repeat> - <repeat name="history_outputs" title="one or more new history items output by the executable to appear in the user history after the tool runs" - help="The name will become a history item for users of the new tool you are making containing one of it's outputs"> - <param name="history_name" type="text" label="Name for this output to appear in new history" optional="false" - help="No spaces! Argparse will also use this name as --[name]"> - <sanitizer invalid_char="_"> - <valid initial="string.letters,string.digits"/> - <add value="_" /> - </sanitizer> - </param> - <param name="history_format" type="select" multiple="false" label="Select the datatype for this output" - help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular"> - <options from_parameter="tool.app.datatypes_registry.upload_file_formats"> - <column name="value" index="0"/> - </options> - </param> - <param name="history_CL" type="text" label="Positional: ordinal integer. Use STDOUT if '>' required. Otherwise ignored if argparse because name is used" - help="If positional parameters, enter the integer ordinal expected for this parameter. If argparse, ignore unless STDOUT needed" value=""/> - <param name="history_test" type="text" label="Test pass decision criterion for this output compared to test generation" - help="Available options are diff:[lines], sim_size:[delta (integer) or delta_frac (float)" value="diff:0"/> - </repeat> - </section> - </xml> - <xml name="additparam"> - <section name="addparam" title="Executable or script settings passed on the command line other than I/O files" expanded="true"> - <param name="edit_params" type="select" display="radio" label="Make these settings on the generated tool form user editable?" - help="If no, users will NOT be able to alter any additional parameters. If yes, these will appear on the tool form as text fields with no validation or sanitizing"> - <option value="yes" selected="true">Yes, allow user to edit all additional parameters on the generated tool form</option> - <option value="no">No - use the fixed values for all additional parameters - no user editing</option> - </param> - - <repeat name="additional_parameters" title="zero or more settings to be set by the tool user and passed on the command line" - help="See examples below to see how these can be parsed by scripts in the various languages"> - <param name="param_name" type="text" value="" label="Choose the name for this parameter - MUST not be blank!"> - <sanitizer invalid_char=""> - <valid initial="string.letters,string.digits"/> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="param_type" type="select" label="Select the type for this parameter"> - <option value="text" selected="true">text</option> - <option value="integer">integer</option> - <option value="float">float</option> - </param> - <param name="param_value" type="text" value="" label="Enter this parameter's default value" - help="Note that '~~~' is an internal delimiter must not appear in this text field - please work around this technical limitation" > - <sanitizer invalid_char=""> - <valid initial="string.printable"> <remove value='~~~'/> </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="param_label" type="text" value="" label="Enter this parameter's label for the form" - help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" > - <sanitizer invalid_char=""> - <valid initial="string.printable"> <remove value='~~~'/> </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="param_help" type="text" value="" label="Help for this parameter" - help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation" > - <sanitizer invalid_char=""> - <valid initial="string.printable"> <remove value='~~~'/> </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="param_CL" type="text" label="Positional ordinal | argparse argument name" - help="Using positional parameters, enter the integer ordinal for this parameter on the command line. Using Argparse style, '--' will be prepended on the CL" value="" /> - <param name="param_CLprefixed" type="text" label="Override the generated default argparse name prefix if not empty - eg ----foo if needed" - help="Some targets like Planemo expect an unadorned action like 'test' before --galaxy_root." value="" /> - </repeat> - </section> - </xml> - </macros> - -<requirements> - <requirement type="package" version="0.4.11">galaxyxml</requirement> - <requirement type="package" version="0.14.0">bioblend</requirement> - <requirement type="package" version="0.10.6">ephemeris</requirement> - <requirement type="package" version="4.4.0">docker-py</requirement> - <!-- <requirement type="package" version="0.72.0">planemo</requirement> --> - <container type="docker">quay.io/fubar2/planemo-biocontainer:latest</container> -</requirements> - - <command ><![CDATA[ -#import os -#set dev_env = os.environ.get('GALAXY_DEVELOPMENT_ENVIRONMENT', '0') == '1' -#if not $dev_env and ( $__user_email__ not in $__admin_users__ ): -python3 $__tool_directory__/rgToolFactory2.py --bad_user $__user_email__ - #else: -python3 $__tool_directory__/rgToolFactory2.py - #if len(str($cl_prefix)) > 3: ---cl_prefix "$cl_prefix" - #end if - #if $cover.commover == "yes": - #if len(str($cover.command_override)) > 10: ---command_override "$commandoverride" - #end if - #if len(str($cover.test_override)) > 10: ---test_override "$testoverride" - #end if - #end if ---packages "$deps.packages" - #if $deps.usescript.choosescript == "yes": ---script_path "$runme" ---sysexe "$deps.usescript.scriptrunner" - #end if ---tool_name "$tool_name" --user_email "$__user_email__" --citations "$citeme" --parampass "$io_param.ppass.parampass" - - #if str($make.makeMode.make_Tool)!="runonly": ---make_Tool "$make.makeMode.make_Tool" ---tool_desc "$make.makeMode.tool_desc" ---tool_version "$make.makeMode.tool_version" ---help_text "$helpme" ---new_tool "$new_tool" ---toolshed_api_key "$make.makeMode.toolshed_apikey" ---galaxy_api_key "$make.makeMode.galaxy_apikey" ---toolshed_url "$make.makeMode.toolshed_url" ---galaxy_url "$make.makeMode.galaxy_url" - #end if - #if $io_param.ppass.parampass != '0': - #if str($io_param.ppass.addparam.edit_params) == "yes": ---edit_additional_parameters - #end if - #for apar in $io_param.ppass.addparam.additional_parameters: ---additional_parameters "$apar.param_name~~~$apar.param_value~~~$apar.param_label~~~$apar.param_help~~~$apar.param_type~~~$apar.param_CL~~~$apar.param_CLprefixed" - #end for - #end if - #for $intab in $io_param.ppass.io.history_inputs: ---input_files "$intab.input_files~~~$intab.input_CL~~~$intab.input_formats~~~$intab.input_label~~~$intab.input_help" - #end for - #for $otab in $io_param.ppass.io.history_outputs: ---output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL~~~$otab.history_test" - #end for ---galaxy_root "$__root_dir__" ---tool_dir "$__tool_directory__" - #end if -]]></command> - <configfiles> - <configfile name="runme"> -$deps.usescript.dynScript - </configfile> - <configfile name="commandoverride"> -#if $cover.commover == "yes" and len(str($cover.command_override).strip()) > 1: -$cover.command_override -#end if - </configfile> - <configfile name="testoverride"> -#if $cover.commover == "yes" and len(str($cover.test_override).strip()) > 1: -$cover.test_override -#end if - </configfile> - <configfile name="helpme"> - #if $make.makeMode.make_Tool != "runonly": -${make.makeMode.help_text} - #else -$tool_name help goes here - #end if - </configfile> - <configfile name="citeme"> -#if $make.makeMode.make_Tool != "runonly": - #for $citation in $make.makeMode.citations: - #if $citation.citation_type.type == "bibtex": - **ENTRY**bibtex - ${citation.citation_type.bibtex} - #else - **ENTRY**doi - ${citation.citation_type.doi} - #end if - #end for -#end if - </configfile> - </configfiles> - <inputs> - <param name="tool_name" type="text" value="tool1" label="New tool ID and title for outputs" - help="Toolshed repository name. Choose thoughtfully to avoid namespace clashes with other tool writers. Lower case, digits and underscores only"> - <sanitizer invalid_char=""> - <valid initial="string.ascii_lowercase,string.digits"> - <add value="_"/> - </valid> - </sanitizer> - </param> - - <section name="deps" title="Dependencies, optional script and script interpreter" expanded="true"> - - <param name="packages" type="text" value="" label="Conda dependencies as package name[:version, name:version...]. These will always be available when this tool executes" - optional="false" help="Use =[ver] or :[ver] for specific version - 'bwa=0.17.0'. Default is latest. Will be used every time the tool is (re)run. Only Conda is currently supported" /> - - <conditional name="usescript"> - <param name="choosescript" type="select" display="radio" label="Supply a script for a dependency (e.g. python/R/bash) or a system executable such as Bash" - help = "For script interpreters like Python or bash, parameters and i/o specified below must match script's expectations - if you pass parameters, the script must deal with them"> - <option value="no">No script required for this tool - just pass parameters on the command line to the first dependency listed above</option> - <option value="yes" selected="true">Yes, a script is ready to be pasted below</option> - </param> - <when value="no"> - <param name="dynScript" type="hidden" value="" /> - <param name="scriptrunner" type="hidden" value="" /> - </when> - <when value="yes"> - <param name="scriptrunner" type="text" value="" label="Interpreter for the script - eg bash or python. Can be one of the dependencies named above or a system executable" - help="Scripts are interpreted by the executable named here. Use bash for bash scripts, or a conda dependency such as R or Python for those scripts"> - <sanitizer invalid_char=""> - <valid initial="string.letters,string.digits"> - <add value="_"/> - </valid> - </sanitizer> - </param> - <param name="dynScript" type="text" area="True" value="" label="Script for executable above to interpret. It can be one of the Conda dependency names " - help="Script must handle all i/o and parameters as specified below using the parameters and passing method chosen below"> - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - </when> - </conditional> - </section> - <section name="io_param" title="Data file input, output and settings forming the executable or script command line" expanded="true"> - <conditional name="ppass"> - <param name="parampass" type="select" display="radio" label="Command line parameter passing method to use"> - <option value="argparse" selected="true">Argparse: passed in the form of --clname value</option> - <option value="positional">Positional: Passed in the order of positional ordinals ...foo.bam bar.idx zot.xls</option> - <option value="0">Tool reads selected input file from STDIN and writes STDOUT with no parameters</option> - </param> - <when value="argparse"> - <expand macro="io" /> - <expand macro="additparam" /> - </when> - <when value="positional"> - <expand macro="io" /> - <expand macro="additparam" /> - </when> - <when value="0"> - <expand macro="io"/> - </when> - </conditional> - </section> - <param name="cl_prefix" type="text" value="" label="Prefix for generated command line. Prepends generated i/o and parameter CL. Use override below to replace completely" - help="Text will replace generated executable/script elements. Sometimes required before i/o and parameters in the generated command line." /> - <conditional name="cover"> - <param name="commover" type="select" display="radio" label="Add Human wrought code to override the generated XML command and/or test section - DIY" - help = "For arbitrary and artfull command lines. All i/o and parameters must be passed. Choose No unless needed. Not for the faint of heart"> - <option value="no" selected="true">No. Use automatically generated command/test XML </option> - <option value="yes">Yes. XML needed to override autogenerated command and/or test segments will be pasted below</option> - </param> - <when value="no"> - <param name="command_override" type="hidden" value="" /> - <param name="test_override" type="hidden" value="" /> - </when> - <when value="yes"> - <param name="command_override" type="text" area="True" value="" label="Optional. Human wrought command element override XML/template - e.g. for bwa" - help="For arbitrary and artfull command lines. All i/o and parameters must be passed. Leave blank unless needed. Not for the faint of heart"> - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="test_override" type="text" area="True" value="" label="Optional. Human wrought test element override XML/template - e.g. for bwa" - help="For arbitrary and artfull scripts. Leave blank unless needed. Not for the faint of heart"> - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - </when> - </conditional> - <section name="make" title="Generate, toolshed and local Galaxy installation options" expanded="true"> - <conditional name="makeMode"> - <param name="make_Tool" type="select" display="radio" label="Choose the steps you want to run. The TF Docker container is recommended for local installation" - help="Installation in this Galaxy is optional" > - <option value="generate" >Run to generate tests only. Should fail if dependencies needed.</option> - <option value="gentest">Test with planemo after generating.</option> - <option value="gentestinstall" selected="true">Install in this Galaxy after generation and testing. Must have local ToolShed as in the TF Docker container</option> - </param> - <when value="generate"> - <param name="galaxy_apikey" value="" type="hidden" ></param> - <param name="toolshed_apikey" value="" type="hidden" ></param> - <param name="galaxy_url" value="" type="hidden" ></param> - <param name="toolshed_url" value="" type="hidden" ></param> - <expand macro="tool_metadata" /> - </when> - <when value="gentest"> - <param name="galaxy_apikey" value="" type="hidden" ></param> - <param name="toolshed_apikey" value="" type="hidden" ></param> - <param name="galaxy_url" value="" type="hidden" ></param> - <param name="toolshed_url" value="" type="hidden" ></param> - <expand macro="tool_metadata" /> - </when> - <when value="gentestinstall"> - <param name="galaxy_url" type="text" value="http://localhost:8080" label="URL for the Galaxy server where the new tool should be installed" - help="Default is localhost"> - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="galaxy_apikey" type="text" value="fakekey" label="API key for the Galaxy to install the new tool" - help="Cut and paste from the admin user properties screen"> - <sanitizer> - <valid initial="string.letters,string.digits"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="toolshed_url" type="text" value="http://localhost:9009" label="URL for the Toolshed where the new tool should be installed" - help="Default value is localhost:9009"> - <sanitizer> - <valid initial="string.printable"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <param name="toolshed_apikey" type="text" value="fakekey" label="API key for the local toolshed to use when installing the tool" - help="Cut and paste from the admin user properties screen"> - <sanitizer> - <valid initial="string.letters,string.digits"> - </valid> - <mapping initial="none"/> - </sanitizer> - </param> - <expand macro="tool_metadata" /> - </when> - </conditional> - </section> - </inputs> - <outputs> - - <data format="tgz" name="new_tool" label="${tool_name}_toolshed.tgz" > - <filter>makeMode['make_Tool'] != "runonly"</filter> - </data> - - <collection name="TF_run_report" type="list" label="${tool_name} outputs"> - <discover_datasets pattern="__name_and_ext__" directory="TF_run_report_tempdir" /> - </collection> - </outputs> -<tests> -<test> - <param name="user_email" value="admin@galaxy.org"/> - <param name="input_files" value="input1_sample" /> - <param name="input_CL" value="1" /> - <param name="input_formats" value="txt" /> - <param name="input_label" value="input" /> - <param name="input_help" value="help" /> - <param name="tool_name" value="pyrevpos" /> - <param name="parampass" value="positional" /> - <param name="make_Tool" value="generate" /> - <param name="tool_version" value="0.01" /> - <param name="tool_desc" value="positional reverse" /> - <param name="help_text" value="help text goes here" /> - <param name="packages" value="python"/> - <param name="history_name" value="output2" /> - <param name="history_format" value="txt" /> - <param name="history_CL" value="2" /> - <param name="dynScript" value="import sys; inp = sys.argv[1]; outp = sys.argv[2]; inlist = open(inp,'r').readlines(); o = open(outp,'w'); rs = [''.join(list(reversed(x.rstrip()))) for x in inlist]; o.write('\n'.join(rs)); o.close()"/> - <param name="choosescript" value="yes" /> - <param name="script_path" value="$runme"/> - <output name="new_tool" file="toolfactory_pyrevpos_tgz_sample" compare="sim_size" delta="6000" /> -</test> -</tests> -<help> - -.. class:: warningmark - -**Details and attribution** -(see GTF_) - -**Local Admins ONLY** -Only users whose IDs found in the local admin_user configuration setting in universe_wsgi.ini can run this tool. - -**If you find a bug** -Please raise an issue, or even better, submit a pull request fixing it, on the github repository GTF_ - -**What it does** -This tool optionally generates normal workflow compatible first class Galaxy tools - -Generated tools can run existing binary packages that become requirements, existing scripts, or new scripts pasted into this tool form. -Pasted scripts are written so they are part of the new tool and cannot be adjusted by the downstream user. -Binary packages are managed by the dependency subsystem - conda usually, so anything in bioconda or conda_forge is available for example. - -Any number of parameters can be built into the new tool form for passing in to the script or executable at runtime. -These can be editable by the downstream user or baked in. - -When you run this tool, your executable or script and supplied parameter values will be run to produce a canonical -set of outputs - these are used to construct a test for the new tool. - -If tool generation is required, a new tarball compatible with any Galaxy toolshed is created. -It can be unpacked in your galaxy/tools directory and manually added to tool_conf.xml, or -installed into any toolshed from where it can be installed into your Galaxy. - - -.. class:: warningmark - -**Note to system administrators** -This tool offers *NO* built in protection against malicious scripts. It should only be installed on private/personnal Galaxy instances. -Admin_users will have the power to do anything they want as the Galaxy user if you install this tool. - -.. class:: warningmark - -**Use on public servers** is STRONGLY discouraged for obvious reasons - -The tools generated by this tool will run just as securely as any other normal installed Galaxy tool but like any other new tools, should always be checked carefully before installation. -We recommend that you follow the good code hygiene practices associated with safe toolshed practices. - -Here's a sample python script that can be cut and pasted into the tool form, suitable for positional parameter passing: - -:: - - # reverse order of text by row - import sys - inp = sys.argv[1] - outp = sys.argv[2] - i = open(inp,'r').readlines() - o = open(outp,'w') - for row in i: - rs = row.rstrip() - rs = list(rs) - rs.reverse() - o.write(''.join(rs)) - o.write('\n') - o.close() - -With argparse style parameters: - -:: - - # reverse order of text by row - import argparse - parser = argparse.ArgumentParser() - a = parser.add_argument - a('--infile',default='') - a('--outfile',default=None) - args = parser.parse_args() - inp = args.infile - outp = args.outfile - i = open(inp,'r').readlines() - o = open(outp,'w') - for row in i: - rs = row.rstrip() - rs = list(rs) - rs.reverse() - o.write(''.join(rs)) - o.write('\n') - o.close() - - - -Paper_ - -*Licensing* - -Copyright Ross Lazarus (ross period lazarus at gmail period com) May 2012 -All rights reserved. -Licensed under the LGPL_ - -.. _LGPL: http://www.gnu.org/copyleft/lesser.html -.. _GTF: https://github.com/fubar2/toolfactory -.. _Paper: http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573 - - -</help> -<citations> - <citation type="doi">10.1093/bioinformatics/bts573</citation> -</citations> -</tool> - -
--- a/toolfactory/test-data/input1_sample Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,166 +0,0 @@ -*WARNING before you start* - - Install this tool on a private Galaxy ONLY - Please NEVER on a public or production instance - -Updated august 2014 by John Chilton adding citation support - -Updated august 8 2014 to fix bugs reported by Marius van den Beek - -Please cite the resource at -http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref -if you use this tool in your published work. - -**Short Story** - -This is an unusual Galaxy tool capable of generating new Galaxy tools. -It works by exposing *unrestricted* and therefore extremely dangerous scripting -to all designated administrators of the host Galaxy server, allowing them to -run scripts in R, python, sh and perl over multiple selected input data sets, -writing a single new data set as output. - -*You have a working r/python/perl/bash script or any executable with positional or argparse style parameters* - -It can be turned into an ordinary Galaxy tool in minutes, using a Galaxy tool. - - -**Automated generation of new Galaxy tools for installation into any Galaxy** - -A test is generated using small sample test data inputs and parameter settings you supply. -Once the test case outputs have been produced, they can be used to build a -new Galaxy tool. The supplied script or executable is baked as a requirement -into a new, ordinary Galaxy tool, fully workflow compatible out of the box. -Generated tools are installed via a tool shed by an administrator -and work exactly like all other Galaxy tools for your users. - -**More Detail** - -To use the ToolFactory, you should have prepared a script to paste into a -text box, or have a package in mind and a small test input example ready to select from your history -to test your new script. - -```planemo test rgToolFactory2.xml --galaxy_root ~/galaxy --test_data ~/galaxy/tools/tool_makers/toolfactory/test-data``` works for me - -There is an example in each scripting language on the Tool Factory form. You -can just cut and paste these to try it out - remember to select the right -interpreter please. You'll also need to create a small test data set using -the Galaxy history add new data tool. - -If the script fails somehow, use the "redo" button on the tool output in -your history to recreate the form complete with broken script. Fix the bug -and execute again. Rinse, wash, repeat. - -Once the script runs sucessfully, a new Galaxy tool that runs your script -can be generated. Select the "generate" option and supply some help text and -names. The new tool will be generated in the form of a new Galaxy datatype -*toolshed.gz* - as the name suggests, it's an archive ready to upload to a -Galaxy ToolShed as a new tool repository. - -Once it's in a ToolShed, it can be installed into any local Galaxy server -from the server administrative interface. - -Once the new tool is installed, local users can run it - each time, the script -that was supplied when it was built will be executed with the input chosen -from the user's history. In other words, the tools you generate with the -ToolFactory run just like any other Galaxy tool,but run your script every time. - -Tool factory tools are perfect for workflow components. One input, one output, -no variables. - -*To fully and safely exploit the awesome power* of this tool, -Galaxy and the ToolShed, you should be a developer installing this -tool on a private/personal/scratch local instance where you are an -admin_user. Then, if you break it, you get to keep all the pieces see -https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home - -**Installation** -This is a Galaxy tool. You can install it most conveniently using the -administrative "Search and browse tool sheds" link. Find the Galaxy Main -toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory -repository. Open it and review the code and select the option to install it. - -If you can't get the tool that way, the xml and py files here need to be -copied into a new tools -subdirectory such as tools/toolfactory Your tool_conf.xml needs a new entry -pointing to the xml -file - something like:: - - <section name="Tool building tools" id="toolbuilders"> - <tool file="toolfactory/rgToolFactory.xml"/> - </section> - -If not already there, -please add: -<datatype extension="toolshed.gz" type="galaxy.datatypes.binary:Binary" -mimetype="multipart/x-gzip" subclass="True" /> -to your local data_types_conf.xml. - - -**Restricted execution** - -The tool factory tool itself will then be usable ONLY by admin users - -people with IDs in admin_users in universe_wsgi.ini **Yes, that's right. ONLY -admin_users can run this tool** Think about it for a moment. If allowed to -run any arbitrary script on your Galaxy server, the only thing that would -impede a miscreant bent on destroying all your Galaxy data would probably -be lack of appropriate technical skills. - -**What it does** - -This is a tool factory for simple scripts in python, R and -perl currently. Functional tests are automatically generated. How cool is that. - -LIMITED to simple scripts that read one input from the history. Optionally can -write one new history dataset, and optionally collect any number of outputs -into links on an autogenerated HTML index page for the user to navigate - -useful if the script writes images and output files - pdf outputs are shown -as thumbnails and R's bloated pdf's are shrunk with ghostscript so that and -imagemagik need to be available. - -Generated tools can be edited and enhanced like any Galaxy tool, so start -small and build up since a generated script gets you a serious leg up to a -more complex one. - -**What you do** - -You paste and run your script, you fix the syntax errors and -eventually it runs. You can use the redo button and edit the script before -trying to rerun it as you debug - it works pretty well. - -Once the script works on some test data, you can generate a toolshed compatible -gzip file containing your script ready to run as an ordinary Galaxy tool in -a repository on your local toolshed. That means safe and largely automated -installation in any production Galaxy configured to use your toolshed. - -**Generated tool Security** - -Once you install a generated tool, it's just -another tool - assuming the script is safe. They just run normally and their -user cannot do anything unusually insecure but please, practice safe toolshed. -Read the code before you install any tool. Especially this one - it is really scary. - -**Send Code** - -Patches and suggestions welcome as bitbucket issues please? - -**Attribution** - -Creating re-usable tools from scripts: The Galaxy Tool Factory -Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team -Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573 - -http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref - -**Licensing** - -Copyright Ross Lazarus 2010 -ross lazarus at g mail period com - -All rights reserved. - -Licensed under the LGPL - -**Obligatory screenshot** - -http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png -
--- a/toolfactory/test-data/output2_sample Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,165 +0,0 @@ -*trats uoy erofeb GNINRAW* - -YLNO yxalaG etavirp a no loot siht llatsnI -ecnatsni noitcudorp ro cilbup a no REVEN esaelP - -troppus noitatic gnidda notlihC nhoJ yb 4102 tsugua detadpU - -keeB ned nav suiraM yb detroper sgub xif ot 4102 8 tsugua detadpU - -ta ecruoser eht etic esaelP -fer=epytyek&JWYdwMrWs1hQzcl=yekji?375stb/tnirper/igc/gro.slanruojdrofxo.scitamrofnioib//:ptth -.krow dehsilbup ruoy ni loot siht esu uoy fi - -**yrotS trohS** - -.sloot yxalaG wen gnitareneg fo elbapac loot yxalaG lausunu na si sihT -gnitpircs suoregnad ylemertxe erofereht dna *detcirtsernu* gnisopxe yb skrow tI -ot meht gniwolla ,revres yxalaG tsoh eht fo srotartsinimda detangised lla ot -,stes atad tupni detceles elpitlum revo lrep dna hs ,nohtyp ,R ni stpircs nur -.tuptuo sa tes atad wen elgnis a gnitirw - -*sretemarap elyts esrapgra ro lanoitisop htiw elbatucexe yna ro tpircs hsab/lrep/nohtyp/r gnikrow a evah uoY* - -.loot yxalaG a gnisu ,setunim ni loot yxalaG yranidro na otni denrut eb nac tI - - -**yxalaG yna otni noitallatsni rof sloot yxalaG wen fo noitareneg detamotuA** - -.ylppus uoy sgnittes retemarap dna stupni atad tset elpmas llams gnisu detareneg si tset A -a dliub ot desu eb nac yeht ,decudorp neeb evah stuptuo esac tset eht ecnO -tnemeriuqer a sa dekab si elbatucexe ro tpircs deilppus ehT .loot yxalaG wen -.xob eht fo tuo elbitapmoc wolfkrow ylluf ,loot yxalaG yranidro ,wen a otni -rotartsinimda na yb dehs loot a aiv dellatsni era sloot detareneG -.sresu ruoy rof sloot yxalaG rehto lla ekil yltcaxe krow dna - -**liateD eroM** - -a otni etsap ot tpircs a deraperp evah dluohs uoy ,yrotcaFlooT eht esu oT -yrotsih ruoy morf tceles ot ydaer elpmaxe tupni tset llams a dna dnim ni egakcap a evah ro ,xob txet -.tpircs wen ruoy tset ot - -em rof skrow ```atad-tset/yrotcafloot/srekam_loot/sloot/yxalag/~ atad_tset-- yxalag/~ toor_yxalag-- lmx.2yrotcaFlooTgr tset omenalp``` - -uoY .mrof yrotcaF looT eht no egaugnal gnitpircs hcae ni elpmaxe na si erehT -thgir eht tceles ot rebmemer - tuo ti yrt ot eseht etsap dna tuc tsuj nac -gnisu tes atad tset llams a etaerc ot deen osla ll'uoY .esaelp reterpretni -.loot atad wen dda yrotsih yxalaG eht - -ni tuptuo loot eht no nottub "oder" eht esu ,wohemos sliaf tpircs eht fI -gub eht xiF .tpircs nekorb htiw etelpmoc mrof eht etaercer ot yrotsih ruoy -.taeper ,hsaw ,esniR .niaga etucexe dna - -tpircs ruoy snur taht loot yxalaG wen a ,yllufssecus snur tpircs eht ecnO -dna txet pleh emos ylppus dna noitpo "etareneg" eht tceleS .detareneg eb nac -epytatad yxalaG wen a fo mrof eht ni detareneg eb lliw loot wen ehT .seman -a ot daolpu ot ydaer evihcra na s'ti ,stseggus eman eht sa - *zg.dehsloot* -.yrotisoper loot wen a sa dehSlooT yxalaG - -revres yxalaG lacol yna otni dellatsni eb nac ti ,dehSlooT a ni s'ti ecnO -.ecafretni evitartsinimda revres eht morf - -tpircs eht ,emit hcae - ti nur nac sresu lacol ,dellatsni si loot wen eht ecnO -nesohc tupni eht htiw detucexe eb lliw tliub saw ti nehw deilppus saw taht -eht htiw etareneg uoy sloot eht ,sdrow rehto nI .yrotsih s'resu eht morf -.emit yreve tpircs ruoy nur tub,loot yxalaG rehto yna ekil tsuj nur yrotcaFlooT - -,tuptuo eno ,tupni enO .stnenopmoc wolfkrow rof tcefrep era sloot yrotcaf looT -.selbairav on - -,loot siht fo *rewop emosewa eht tiolpxe ylefas dna ylluf oT* -siht gnillatsni repoleved a eb dluohs uoy ,dehSlooT eht dna yxalaG -na era uoy erehw ecnatsni lacol hctarcs/lanosrep/etavirp a no loot -ees seceip eht lla peek ot teg uoy ,ti kaerb uoy fi ,nehT .resu_nimda -emoH/ikiw/yrotcaflootyxalag/rabuf/gro.tekcubtib//:sptth - -**noitallatsnI** -eht gnisu yltneinevnoc tsom ti llatsni nac uoY .loot yxalaG a si sihT -niaM yxalaG eht dniF .knil "sdehs loot esworb dna hcraeS" evitartsinimda -yrotcafloot eht rof hcraes dna /ude.usp.xb.2g.dehsloot//:sptth ta dehsloot -.ti llatsni ot noitpo eht tceles dna edoc eht weiver dna ti nepO .yrotisoper - -eb ot deen ereh selif yp dna lmx eht ,yaw taht loot eht teg t'nac uoy fI -sloot wen a otni deipoc -yrtne wen a sdeen lmx.fnoc_loot ruoY yrotcafloot/sloot sa hcus yrotceridbus -lmx eht ot gnitniop -::ekil gnihtemos - elif - ->"sredliubloot"=di "sloot gnidliub looT"=eman noitces< ->/"lmx.yrotcaFlooTgr/yrotcafloot"=elif loot< ->noitces/< - -,ereht ydaerla ton fI -:dda esaelp -"yraniB:yranib.sepytatad.yxalag"=epyt "zg.dehsloot"=noisnetxe epytatad< ->/ "eurT"=ssalcbus "pizg-x/trapitlum"=epytemim -.lmx.fnoc_sepyt_atad lacol ruoy ot - - -**noitucexe detcirtseR** - -- sresu nimda yb YLNO elbasu eb neht lliw flesti loot yrotcaf loot ehT -YLNO .thgir s'taht ,seY** ini.igsw_esrevinu ni sresu_nimda ni sDI htiw elpoep -ot dewolla fI .tnemom a rof ti tuoba knihT **loot siht nur nac sresu_nimda -dluow taht gniht ylno eht ,revres yxalaG ruoy no tpircs yrartibra yna nur -ylbaborp dluow atad yxalaG ruoy lla gniyortsed no tneb tnaercsim a edepmi -.slliks lacinhcet etairporppa fo kcal eb - -**seod ti tahW** - -dna R ,nohtyp ni stpircs elpmis rof yrotcaf loot a si sihT -.taht si looc woH .detareneg yllacitamotua era stset lanoitcnuF .yltnerruc lrep - -nac yllanoitpO .yrotsih eht morf tupni eno daer taht stpircs elpmis ot DETIMIL -stuptuo fo rebmun yna tcelloc yllanoitpo dna ,tesatad yrotsih wen eno etirw -- etagivan ot resu eht rof egap xedni LMTH detarenegotua na no sknil otni -nwohs era stuptuo fdp - selif tuptuo dna segami setirw tpircs eht fi lufesu -dna taht os tpircstsohg htiw knurhs era s'fdp detaolb s'R dna slianbmuht sa -.elbaliava eb ot deen kigamegami - -trats os ,loot yxalaG yna ekil decnahne dna detide eb nac sloot detareneG -a ot pu gel suoires a uoy steg tpircs detareneg a ecnis pu dliub dna llams -.eno xelpmoc erom - -**od uoy tahW** - -dna srorre xatnys eht xif uoy ,tpircs ruoy nur dna etsap uoY -erofeb tpircs eht tide dna nottub oder eht esu nac uoY .snur ti yllautneve -.llew ytterp skrow ti - gubed uoy sa ti nurer ot gniyrt - -elbitapmoc dehsloot a etareneg nac uoy ,atad tset emos no skrow tpircs eht ecnO -ni loot yxalaG yranidro na sa nur ot ydaer tpircs ruoy gniniatnoc elif pizg -detamotua ylegral dna efas snaem tahT .dehsloot lacol ruoy no yrotisoper a -.dehsloot ruoy esu ot derugifnoc yxalaG noitcudorp yna ni noitallatsni - -**ytiruceS loot detareneG** - -tsuj s'ti ,loot detareneg a llatsni uoy ecnO -rieht dna yllamron nur tsuj yehT .efas si tpircs eht gnimussa - loot rehtona -.dehsloot efas ecitcarp ,esaelp tub erucesni yllausunu gnihtyna od tonnac resu -.yracs yllaer si ti - eno siht yllaicepsE .loot yna llatsni uoy erofeb edoc eht daeR - -**edoC dneS** - -?esaelp seussi tekcubtib sa emoclew snoitseggus dna sehctaP - -**noitubirttA** - -yrotcaF looT yxalaG ehT :stpircs morf sloot elbasu-er gnitaerC -maeT yxalaG ehT ;nnameiZ kraM ;ipsaK ynotnA ;surazaL ssoR -375stb/scitamrofnioib/3901.01 :iod ;2102 scitamrofnioiB - -fer=epytyek&JWYdwMrWs1hQzcl=yekji?375stb/tnirper/igc/gro.slanruojdrofxo.scitamrofnioib//:ptth - -**gnisneciL** - -0102 surazaL ssoR thgirypoC -moc doirep liam g ta surazal ssor - -.devreser sthgir llA - -LPGL eht rednu desneciL - -**tohsneercs yrotagilbO** - -gnp.looTtpircScimanyd/segami/989ef2308adf/crs/rekamlootyxalag/rabuf/gro.tekcubtib//:ptth
--- a/toolfactory/test-data/pyrevpos.python Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -# reverse order of text by row -import sys -inp = sys.argv[1] -outp = sys.argv[2] -i = open(inp,'r').readlines() -o = open(outp,'w') -for row in i: - rs = row.rstrip() - rs = list(rs) - rs.reverse() - o.write(''.join(rs)) -o.close() -
--- a/toolfactory/test-data/test1_log.txt Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1 +0,0 @@ -## Executing Toolfactory generated command line = python /tmp/pyrevposq5dmcdy1.python /tmp/tmpqrksf8sd/files/5/b/9/dataset_5b952a86-87df-44ad-a415-ea549f3f0cee.dat output2
--- a/toolfactory/testtf.sh Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,2 +0,0 @@ -planemo test --no_cleanup --no_dependency_resolution --skip_venv --galaxy_root ~/galaxy ~/galaxy/tools/tool_makers/toolfactory &>foo -
--- a/toolfactory/whoosh.sh Fri Dec 11 02:52:53 2020 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -# using the galaxy venv this seems to work -. /galaxy_venv/bin/activate -python scripts/tool_shed/build_ts_whoosh_index.py -c config/tool_shed.yml --config-section tool_shed -# eeesh. /etc/galaxy is where the actual galaxy.yml lives - despite other configs being where they might be expected -# fix tool_shed.yml to 0.0.0.0 and admin email -# add tgz to datatypes :( -# need to source a venv in /export/tool_deps/toolfactorydeps/0.01/fubar/toolfactorydeps/9e9428fe9134/env.sh -# as nothing was done by the setup_virtualenv step apparently. -# gcc and friends for planemo pip installation -# File "/galaxy-central/lib/galaxy/tool_util/verify/interactor.py", line 595, in <listcomp> -# test_user = [user for user in all_users if user["email"] == email][0] -# add local to tool_sheds_conf.xml -# <tool_sheds> -# <tool_shed name="local" url="http://localhost:9009"/> -# mercurial > 5.5!! -
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/LICENSE Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,504 @@ +GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +(This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.) + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + {signature of Ty Coon}, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it!
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/README.md Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,169 @@ +# Breaking news! Docker container at https://github.com/fubar2/toolfactory-galaxy-docker recommended as at December 2020 + +## This ToolFactory is for docker use and is used in the new recommended Docker ToolFactory + +## For non-Docker situations, use the ordinary ToolFactory https://github.com/fubar2/toolfactory + + +# WARNING + +Install this tool to a throw-away private Galaxy or Docker container ONLY! + +Please NEVER on a public or production instance where a hostile user may +be able to gain access if they can acquire an administrative account login. + +It only runs for server administrators - the ToolFactory tool will refuse to execute for an ordinary user since +it can install new tools to the Galaxy server it executes on! This is not something you should allow other than +on a throw away instance that is protected from potentially hostile users. + +## Short Story + +Galaxy is easily extended to new applications by adding a new tool. Each new scientific computational package added as +a tool to Galaxy requires an XML document describing how the application interacts with Galaxy. +This is sometimes termed "wrapping" the package because the instructions tell Galaxy how to run the package +as a new Galaxy tool. Any tool that has been wrapped is readily available to all the users through a consistent +and easy to use interface once installed in the local Galaxy server. + +Most Galaxy tool wrappers have been manually prepared by skilled programmers, many using Planemo because it +automates much of the boilerplate and makes the process much easier. +The ToolFactory (TF) now uses Planemo under the hood for testing, but hides the command +line complexities. The user will still need appropriate skills in terms of describing the interface between +Galaxy and the new application, but will be helped by a Galaxy tool form to collect all the needed +settings, together with automated testing and uploading to a toolshed with optional local installation. + +## More Explanation + +The TF is an unusual Galaxy tool, designed to allow a skilled user to make new Galaxy tools. +It appears in Galaxy just like any other tool but outputs include new Galaxy tools generated +using instructions provided by the user and the results of Planemo lint and tool testing using +small sample inputs provided by the TF user. The small samples become tests built in to the new tool. + +It offers a familiar Galaxy form driven way to define how the user of the new tool will +choose input data from their history, and what parameters the new tool user will be able to adjust. +The TF user must know, or be able to read, enough about the tool to be able to define the details of +the new Galaxy interface and the ToolFactory offers little guidance on that other than some examples. + +Tools always depend on other things. Most tools in Galaxy depend on third party +scientific packages, so TF tools usually have one or more dependencies. These can be +scientific packages such as BWA or scripting languages such as Python and are +managed by Conda. If the new tool relies on a system utility such as bash or awk +where the importance of version control on reproducibility is low, these can be used without +Conda management - but remember the potential risks of unmanaged dependencies on computational +reproducibility. + +The TF user can optionally supply a working script where scripting is +required and the chosen dependency is a scripting language such as Python or a system +scripting executable such as bash. Whatever the language, the script must correctly parse the command line +arguments it receives at tool execution, as they are defined by the TF user. The +text of that script is "baked in" to the new tool and will be executed each time +the new tool is run. It is highly recommended that scripts and their command lines be developed +and tested until proven to work before the TF is invoked. Galaxy as a software development +environment is actually possible, but not recommended being somewhat clumsy and inefficient. + +Tools nearly always take one or more data sets from the user's history as input. TF tools +allow the TF user to define what Galaxy datatypes the tool end user will be able to choose and what +names or positions will be used to pass them on a command line to the package or script. + +Tools often have various parameter settings. The TF allows the TF user to define how each +parameter will appear on the tool form to the end user, and what names or positions will be +used to pass them on the command line to the package. At present, parameters are limited to +simple text and number fields. Pull requests for other kinds of parameters that galaxyxml +can handle are welcomed. + +Best practice Galaxy tools have one or more automated tests. These should use small sample data sets and +specific parameter settings so when the tool is tested, the outputs can be compared with their expected +values. The TF will automatically create a test for the new tool. It will use the sample data sets +chosen by the TF user when they built the new tool. + +The TF works by exposing *unrestricted* and therefore extremely dangerous scripting +to all designated administrators of the host Galaxy server, allowing them to +run scripts in R, python, sh and perl. For this reason, a Docker container is +available to help manage the associated risks. + +## Scripting uses + +To use a scripting language to create a new tool, you must first prepared and properly test a script. Use small sample +data sets for testing. When the script is working correctly, upload the small sample datasets +into a new history, start configuring a new ToolFactory tool, and paste the script into the script text box on the TF form. + +### Outputs + +The TF will generate the new tool described on the TF form, and test it +using planemo. Optionally if a local toolshed is running, it can be used to +install the new tool back into the generating Galaxy. + +A toolshed is built in to the Docker container and configured +so a tool can be tested, sent to that toolshed, then installed in the Galaxy +where the TF is running using the default toolshed and Galaxy URL and API keys. + +Once it's in a ToolShed, it can be installed into any local Galaxy server +from the server administrative interface. + +Once the new tool is installed, local users can run it - each time, the +package and/or script that was supplied when it was built will be executed with the input chosen +from the user's history, together with user supplied parameters. In other words, the tools you generate with the +TF run just like any other Galaxy tool. + +TF generated tools work as normal workflow components. + + +## Limitations + +The TF is flexible enough to generate wrappers for many common scientific packages +but the inbuilt automation will not cope with all possible situations. Users can +supply overrides for two tool XML segments - tests and command and the BWA +example in the supplied samples workflow illustrates their use. It does not deal with +repeated elements or conditional parameters such as allowing a user to choose to see "simple" +or "advanced" parameters (yet) and there will be plenty of packages it just +won't cover - but it's a quick and efficient tool for the other 90% of cases. Perfect for +that bash one liner you need to get that workflow functioning correctly for this +afternoon's demonstration! + +## Installation + +The Docker container https://github.com/fubar2/toolfactory-galaxy-docker/blob/main/README.md +is the best way to use the TF because it is preconfigured +to automate new tool testing and has a built in local toolshed where each new tool +is uploaded. If you grab the docker container, it should just work after a restart and you +can run a workflow to generate all the sample tools. Running the samples and rerunning the ToolFactory +jobs that generated them allows you to add fields and experiment to see how things work. + +It can be installed like any other tool from the Toolshed, but you will need to make some +configuration changes (TODO write a configuration). You can install it most conveniently using the +administrative "Search and browse tool sheds" link. Find the Galaxy Main +toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory +repository in the Tool Maker section. Open it and review the code and select the option to install it. + +If not already there please add: + +``` +<datatype extension="tgz" type="galaxy.datatypes.binary:Binary" mimetype="multipart/x-gzip" subclass="True" /> +``` + +to your local config/data_types_conf.xml. + + +## Restricted execution + +The tool factory tool itself will ONLY run for admin users - +people with IDs in config/galaxy.yml "admin_users". + +*ONLY admin_users can run this tool* + +That doesn't mean it's safe to install on a shared or exposed instance - please don't. + +## Generated tool Security + +Once you install a generated tool, it's just +another tool - assuming the script is safe. They just run normally and their +user cannot do anything unusually insecure but please, practice safe toolshed. +Read the code before you install any tool. Especially this one - it is really scary. + +## Attribution + +Creating re-usable tools from scripts: The Galaxy Tool Factory +Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team +Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573 + +http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/rgToolFactory2.py Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,1096 @@ +# replace with shebang for biocontainer +# see https://github.com/fubar2/toolfactory +# +# copyright ross lazarus (ross stop lazarus at gmail stop com) May 2012 +# +# all rights reserved +# Licensed under the LGPL +# suggestions for improvement and bug fixes welcome at +# https://github.com/fubar2/toolfactory +# +# July 2020: BCC was fun and I feel like rip van winkle after 5 years. +# Decided to +# 1. Fix the toolfactory so it works - done for simplest case +# 2. Fix planemo so the toolfactory function works +# 3. Rewrite bits using galaxyxml functions where that makes sense - done +# +# uses planemo in a biodocker sort of image as a requirement +# otherwise planemo seems to leak dependencies back into the +# calling venv. Hilarity ensues. + + +# # expects tarball as first, html out as second parameter +# cp $1 foo.tar.gz +# tar -xvzf foo.tar.gz +# TOOLNAME=`find . -name "*.xml"` +# echo "*****TOOLNAME = $TOOLNAME" +# planemo test --test_output $2 $TOOLNAME + +import argparse +import copy +import logging +import os +import re +import shutil +import subprocess +import sys +import tarfile +import tempfile +import time + + +from bioblend import ConnectionError +from bioblend import toolshed + +import docker + +import galaxyxml.tool as gxt +import galaxyxml.tool.parameters as gxtp + +import lxml + +import yaml + + +myversion = "V2.1 July 2020" +verbose = True +debug = True +toolFactoryURL = "https://github.com/fubar2/toolfactory" +ourdelim = "~~~" + +# --input_files="$intab.input_files~~~$intab.input_CL~~~ +# $intab.input_formats# ~~~$intab.input_label +# ~~~$intab.input_help" +IPATHPOS = 0 +ICLPOS = 1 +IFMTPOS = 2 +ILABPOS = 3 +IHELPOS = 4 +IOCLPOS = 5 + +# --output_files "$otab.history_name~~~$otab.history_format~~~ +# $otab.history_CL~~~$otab.history_test" +ONAMEPOS = 0 +OFMTPOS = 1 +OCLPOS = 2 +OTESTPOS = 3 +OOCLPOS = 4 + + +# --additional_parameters="$i.param_name~~~$i.param_value~~~ +# $i.param_label~~~$i.param_help~~~$i.param_type +# ~~~$i.CL~~~i$.param_CLoverride" +ANAMEPOS = 0 +AVALPOS = 1 +ALABPOS = 2 +AHELPPOS = 3 +ATYPEPOS = 4 +ACLPOS = 5 +AOVERPOS = 6 +AOCLPOS = 7 + + +foo = len(lxml.__version__) +# fug you, flake8. Say my name! +FAKEEXE = "~~~REMOVE~~~ME~~~" +# need this until a PR/version bump to fix galaxyxml prepending the exe even +# with override. + + +def timenow(): + """return current time as a string""" + return time.strftime("%d/%m/%Y %H:%M:%S", time.localtime(time.time())) + + +def quote_non_numeric(s): + """return a prequoted string for non-numerics + useful for perl and Rscript parameter passing? + """ + try: + _ = float(s) + return s + except ValueError: + return '"%s"' % s + + +html_escape_table = { + "&": "&", + ">": ">", + "<": "<", + "#": "#", + "$": "$", +} +cheetah_escape_table = {"$": "\\$", "#": "\\#"} + + +def html_escape(text): + """Produce entities within text.""" + return "".join([html_escape_table.get(c, c) for c in text]) + + +def cheetah_escape(text): + """Produce entities within text.""" + return "".join([cheetah_escape_table.get(c, c) for c in text]) + + +def html_unescape(text): + """Revert entities within text. Multiple character targets so use replace""" + t = text.replace("&", "&") + t = t.replace(">", ">") + t = t.replace("<", "<") + t = t.replace("\\$", "$") + t = t.replace("$", "$") + t = t.replace("#", "#") + return t + + +def parse_citations(citations_text): + """""" + citations = [c for c in citations_text.split("**ENTRY**") if c.strip()] + citation_tuples = [] + for citation in citations: + if citation.startswith("doi"): + citation_tuples.append(("doi", citation[len("doi") :].strip())) + else: + citation_tuples.append(("bibtex", citation[len("bibtex") :].strip())) + return citation_tuples + + +class Error(Exception): + """Base class for exceptions in this module.""" + + pass + + +class ScriptRunner: + """Wrapper for an arbitrary script + uses galaxyxml + + """ + + def __init__(self, args=None): + """ + prepare command line cl for running the tool here + and prepare elements needed for galaxyxml tool generation + """ + self.ourcwd = os.getcwd() + self.ourenv = copy.deepcopy(os.environ) + self.infiles = [x.split(ourdelim) for x in args.input_files] + self.outfiles = [x.split(ourdelim) for x in args.output_files] + self.addpar = [x.split(ourdelim) for x in args.additional_parameters] + self.args = args + self.cleanuppar() + self.lastclredirect = None + self.lastxclredirect = None + self.cl = [] + self.xmlcl = [] + self.is_positional = self.args.parampass == "positional" + if self.args.sysexe: + self.executeme = self.args.sysexe + else: + if self.args.packages: + self.executeme = self.args.packages.split(",")[0].split(":")[0].strip() + else: + self.executeme = None + aCL = self.cl.append + aXCL = self.xmlcl.append + assert args.parampass in [ + "0", + "argparse", + "positional", + ], 'args.parampass must be "0","positional" or "argparse"' + self.tool_name = re.sub("[^a-zA-Z0-9_]+", "", args.tool_name) + self.tool_id = self.tool_name + self.newtool = gxt.Tool( + self.tool_name, + self.tool_id, + self.args.tool_version, + self.args.tool_desc, + FAKEEXE, + ) + self.newtarpath = "toolfactory_%s.tgz" % self.tool_name + self.tooloutdir = "./tfout" + self.repdir = "./TF_run_report_tempdir" + self.testdir = os.path.join(self.tooloutdir, "test-data") + if not os.path.exists(self.tooloutdir): + os.mkdir(self.tooloutdir) + if not os.path.exists(self.testdir): + os.mkdir(self.testdir) + if not os.path.exists(self.repdir): + os.mkdir(self.repdir) + self.tinputs = gxtp.Inputs() + self.toutputs = gxtp.Outputs() + self.testparam = [] + if self.args.script_path: + self.prepScript() + if self.args.command_override: + scos = open(self.args.command_override, "r").readlines() + self.command_override = [x.rstrip() for x in scos] + else: + self.command_override = None + if self.args.test_override: + stos = open(self.args.test_override, "r").readlines() + self.test_override = [x.rstrip() for x in stos] + else: + self.test_override = None + if self.args.cl_prefix: # DIY CL start + clp = self.args.cl_prefix.split(" ") + for c in clp: + aCL(c) + aXCL(c) + else: + if self.args.script_path: + aCL(self.executeme) + aCL(self.sfile) + aXCL(self.executeme) + aXCL("$runme") + else: + aCL(self.executeme) + aXCL(self.executeme) + self.elog = os.path.join(self.repdir, "%s_error_log.txt" % self.tool_name) + self.tlog = os.path.join(self.repdir, "%s_runner_log.txt" % self.tool_name) + + if self.args.parampass == "0": + self.clsimple() + else: + clsuffix = [] + xclsuffix = [] + for i, p in enumerate(self.infiles): + if p[IOCLPOS].upper() == "STDIN": + appendme = [ + p[ICLPOS], + p[ICLPOS], + p[IPATHPOS], + "< %s" % p[IPATHPOS], + ] + xappendme = [ + p[ICLPOS], + p[ICLPOS], + p[IPATHPOS], + "< $%s" % p[ICLPOS], + ] + else: + appendme = [p[IOCLPOS], p[ICLPOS], p[IPATHPOS], ""] + xappendme = [p[IOCLPOS], p[ICLPOS], "$%s" % p[ICLPOS], ""] + clsuffix.append(appendme) + xclsuffix.append(xappendme) + for i, p in enumerate(self.outfiles): + if p[OOCLPOS] == "STDOUT": + self.lastclredirect = [">", p[ONAMEPOS]] + self.lastxclredirect = [">", "$%s" % p[OCLPOS]] + else: + clsuffix.append([p[OCLPOS], p[ONAMEPOS], p[ONAMEPOS], ""]) + xclsuffix.append([p[OCLPOS], p[ONAMEPOS], "$%s" % p[ONAMEPOS], ""]) + for p in self.addpar: + clsuffix.append([p[AOCLPOS], p[ACLPOS], p[AVALPOS], p[AOVERPOS]]) + xclsuffix.append( + [p[AOCLPOS], p[ACLPOS], '"$%s"' % p[ANAMEPOS], p[AOVERPOS]] + ) + clsuffix.sort() + xclsuffix.sort() + self.xclsuffix = xclsuffix + self.clsuffix = clsuffix + if self.args.parampass == "positional": + self.clpositional() + else: + self.clargparse() + + def prepScript(self): + rx = open(self.args.script_path, "r").readlines() + rx = [x.rstrip() for x in rx] + rxcheck = [x.strip() for x in rx if x.strip() > ""] + assert len(rxcheck) > 0, "Supplied script is empty. Cannot run" + self.script = "\n".join(rx) + fhandle, self.sfile = tempfile.mkstemp( + prefix=self.tool_name, suffix="_%s" % (self.executeme) + ) + tscript = open(self.sfile, "w") + tscript.write(self.script) + tscript.close() + self.escapedScript = [cheetah_escape(x) for x in rx] + self.spacedScript = [f" {x}" for x in rx if x.strip() > ""] + art = "%s.%s" % (self.tool_name, self.executeme) + artifact = open(art, "wb") + artifact.write(bytes("\n".join(self.escapedScript), "utf8")) + artifact.close() + + def cleanuppar(self): + """ positional parameters are complicated by their numeric ordinal""" + if self.args.parampass == "positional": + for i, p in enumerate(self.infiles): + assert ( + p[ICLPOS].isdigit() or p[ICLPOS].strip().upper() == "STDIN" + ), "Positional parameters must be ordinal integers - got %s for %s" % ( + p[ICLPOS], + p[ILABPOS], + ) + for i, p in enumerate(self.outfiles): + assert ( + p[OCLPOS].isdigit() or p[OCLPOS].strip().upper() == "STDOUT" + ), "Positional parameters must be ordinal integers - got %s for %s" % ( + p[OCLPOS], + p[ONAMEPOS], + ) + for i, p in enumerate(self.addpar): + assert p[ + ACLPOS + ].isdigit(), "Positional parameters must be ordinal integers - got %s for %s" % ( + p[ACLPOS], + p[ANAMEPOS], + ) + for i, p in enumerate(self.infiles): + infp = copy.copy(p) + icl = infp[ICLPOS] + infp.append(icl) + if ( + infp[ICLPOS].isdigit() + or self.args.parampass == "0" + or infp[ICLPOS].strip().upper() == "STDOUT" + ): + scl = "input%d" % (i + 1) + infp[ICLPOS] = scl + self.infiles[i] = infp + for i, p in enumerate(self.outfiles): + p.append(p[OCLPOS]) # keep copy + if (p[OOCLPOS].isdigit() and self.args.parampass != "positional") or p[ + OOCLPOS + ].strip().upper() == "STDOUT": + scl = p[ONAMEPOS] + p[OCLPOS] = scl + self.outfiles[i] = p + for i, p in enumerate(self.addpar): + p.append(p[ACLPOS]) + if p[ACLPOS].isdigit(): + scl = "param%s" % p[ACLPOS] + p[ACLPOS] = scl + self.addpar[i] = p + + def clsimple(self): + """no parameters - uses < and > for i/o""" + aCL = self.cl.append + aXCL = self.xmlcl.append + + if len(self.infiles) > 0: + aCL("<") + aCL(self.infiles[0][IPATHPOS]) + aXCL("<") + aXCL("$%s" % self.infiles[0][ICLPOS]) + if len(self.outfiles) > 0: + aCL(">") + aCL(self.outfiles[0][OCLPOS]) + aXCL(">") + aXCL("$%s" % self.outfiles[0][ONAMEPOS]) + + def clpositional(self): + # inputs in order then params + aCL = self.cl.append + for (o_v, k, v, koverride) in self.clsuffix: + if " " in v: + aCL("%s" % v) + else: + aCL(v) + aXCL = self.xmlcl.append + for (o_v, k, v, koverride) in self.xclsuffix: + aXCL(v) + if self.lastxclredirect: + aXCL(self.lastxclredirect[0]) + aXCL(self.lastxclredirect[1]) + + def clargparse(self): + """argparse style""" + aCL = self.cl.append + aXCL = self.xmlcl.append + # inputs then params in argparse named form + + for (o_v, k, v, koverride) in self.xclsuffix: + if koverride > "": + k = koverride + elif len(k.strip()) == 1: + k = "-%s" % k + else: + k = "--%s" % k + aXCL(k) + aXCL(v) + for (o_v, k, v, koverride) in self.clsuffix: + if koverride > "": + k = koverride + elif len(k.strip()) == 1: + k = "-%s" % k + else: + k = "--%s" % k + aCL(k) + aCL(v) + + def getNdash(self, newname): + if self.is_positional: + ndash = 0 + else: + ndash = 2 + if len(newname) < 2: + ndash = 1 + return ndash + + def doXMLparam(self): + """flake8 made me do this...""" + for ( + p + ) in ( + self.outfiles + ): # --output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL~~~$otab.history_test" + newname, newfmt, newcl, test, oldcl = p + test = test.strip() + ndash = self.getNdash(newcl) + aparm = gxtp.OutputData( + name=newname, format=newfmt, num_dashes=ndash, label=newcl + ) + aparm.positional = self.is_positional + if self.is_positional: + if oldcl.upper() == "STDOUT": + aparm.positional = 9999999 + aparm.command_line_override = "> $%s" % newname + else: + aparm.positional = int(oldcl) + aparm.command_line_override = "$%s" % newname + self.toutputs.append(aparm) + ld = None + if test.strip() > "": + if test.startswith("diff"): + c = "diff" + ld = 0 + if test.split(":")[1].isdigit: + ld = int(test.split(":")[1]) + tp = gxtp.TestOutput( + name=newname, + value="%s_sample" % newname, + format=newfmt, + compare=c, + lines_diff=ld, + ) + elif test.startswith("sim_size"): + c = "sim_size" + tn = test.split(":")[1].strip() + if tn > "": + if "." in tn: + delta = None + delta_frac = min(1.0, float(tn)) + else: + delta = int(tn) + delta_frac = None + tp = gxtp.TestOutput( + name=newname, + value="%s_sample" % newname, + format=newfmt, + compare=c, + delta=delta, + delta_frac=delta_frac, + ) + self.testparam.append(tp) + for p in self.infiles: + newname = p[ICLPOS] + newfmt = p[IFMTPOS] + ndash = self.getNdash(newname) + if not len(p[ILABPOS]) > 0: + alab = p[ICLPOS] + else: + alab = p[ILABPOS] + aninput = gxtp.DataParam( + newname, + optional=False, + label=alab, + help=p[IHELPOS], + format=newfmt, + multiple=False, + num_dashes=ndash, + ) + aninput.positional = self.is_positional + self.tinputs.append(aninput) + tparm = gxtp.TestParam(name=newname, value="%s_sample" % newname) + self.testparam.append(tparm) + for p in self.addpar: + ( + newname, + newval, + newlabel, + newhelp, + newtype, + newcl, + override, + oldcl, + ) = p + if not len(newlabel) > 0: + newlabel = newname + ndash = self.getNdash(newname) + if newtype == "text": + aparm = gxtp.TextParam( + newname, + label=newlabel, + help=newhelp, + value=newval, + num_dashes=ndash, + ) + elif newtype == "integer": + aparm = gxtp.IntegerParam( + newname, + label=newname, + help=newhelp, + value=newval, + num_dashes=ndash, + ) + elif newtype == "float": + aparm = gxtp.FloatParam( + newname, + label=newname, + help=newhelp, + value=newval, + num_dashes=ndash, + ) + else: + raise ValueError( + 'Unrecognised parameter type "%s" for\ + additional parameter %s in makeXML' + % (newtype, newname) + ) + aparm.positional = self.is_positional + if self.is_positional: + aparm.positional = int(oldcl) + self.tinputs.append(aparm) + tparm = gxtp.TestParam(newname, value=newval) + self.testparam.append(tparm) + + def doNoXMLparam(self): + """filter style package - stdin to stdout""" + if len(self.infiles) > 0: + alab = self.infiles[0][ILABPOS] + if len(alab) == 0: + alab = self.infiles[0][ICLPOS] + max1s = ( + "Maximum one input if parampass is 0 but multiple input files supplied - %s" + % str(self.infiles) + ) + assert len(self.infiles) == 1, max1s + newname = self.infiles[0][ICLPOS] + aninput = gxtp.DataParam( + newname, + optional=False, + label=alab, + help=self.infiles[0][IHELPOS], + format=self.infiles[0][IFMTPOS], + multiple=False, + num_dashes=0, + ) + aninput.command_line_override = "< $%s" % newname + aninput.positional = self.is_positional + self.tinputs.append(aninput) + tp = gxtp.TestParam(name=newname, value="%s_sample" % newname) + self.testparam.append(tp) + if len(self.outfiles) > 0: + newname = self.outfiles[0][OCLPOS] + newfmt = self.outfiles[0][OFMTPOS] + anout = gxtp.OutputData(newname, format=newfmt, num_dashes=0) + anout.command_line_override = "> $%s" % newname + anout.positional = self.is_positional + self.toutputs.append(anout) + tp = gxtp.TestOutput( + name=newname, value="%s_sample" % newname, format=newfmt + ) + self.testparam.append(tp) + + def makeXML(self): + """ + Create a Galaxy xml tool wrapper for the new script + Uses galaxyhtml + Hmmm. How to get the command line into correct order... + """ + if self.command_override: + self.newtool.command_override = self.command_override # config file + else: + self.newtool.command_override = self.xmlcl + if self.args.help_text: + helptext = open(self.args.help_text, "r").readlines() + safertext = "\n".join([cheetah_escape(x) for x in helptext]) + if self.args.script_path: + scr = [x for x in self.spacedScript if x.strip() > ""] + scr.insert(0, "\n------\n\n\nScript::\n") + if len(scr) > 300: + scr = ( + scr[:100] + + [" >300 lines - stuff deleted", " ......"] + + scr[-100:] + ) + scr.append("\n") + safertext = safertext + "\n".join(scr) + self.newtool.help = safertext + else: + self.newtool.help = ( + "Please ask the tool author (%s) for help \ + as none was supplied at tool generation\n" + % (self.args.user_email) + ) + self.newtool.version_command = None # do not want + requirements = gxtp.Requirements() + if self.args.packages: + for d in self.args.packages.split(","): + ver = "" + d = d.replace("==", ":") + d = d.replace("=", ":") + if ":" in d: + packg, ver = d.split(":") + else: + packg = d + requirements.append( + gxtp.Requirement("package", packg.strip(), ver.strip()) + ) + self.newtool.requirements = requirements + if self.args.parampass == "0": + self.doNoXMLparam() + else: + self.doXMLparam() + self.newtool.outputs = self.toutputs + self.newtool.inputs = self.tinputs + if self.args.script_path: + configfiles = gxtp.Configfiles() + configfiles.append( + gxtp.Configfile(name="runme", text="\n".join(self.escapedScript)) + ) + self.newtool.configfiles = configfiles + tests = gxtp.Tests() + test_a = gxtp.Test() + for tp in self.testparam: + test_a.append(tp) + tests.append(test_a) + self.newtool.tests = tests + self.newtool.add_comment( + "Created by %s at %s using the Galaxy Tool Factory." + % (self.args.user_email, timenow()) + ) + self.newtool.add_comment("Source in git at: %s" % (toolFactoryURL)) + self.newtool.add_comment( + "Cite: Creating re-usable tools from scripts doi:10.1093/bioinformatics/bts573" + ) + exml0 = self.newtool.export() + exml = exml0.replace(FAKEEXE, "") # temporary work around until PR accepted + if ( + self.test_override + ): # cannot do this inside galaxyxml as it expects lxml objects for tests + part1 = exml.split("<tests>")[0] + part2 = exml.split("</tests>")[1] + fixed = "%s\n%s\n%s" % (part1, self.test_override, part2) + exml = fixed + # exml = exml.replace('range="1:"', 'range="1000:"') + xf = open("%s.xml" % self.tool_name, "w") + xf.write(exml) + xf.write("\n") + xf.close() + # ready for the tarball + + def run(self): + """ + generate test outputs by running a command line + won't work if command or test override in play - planemo is the + easiest way to generate test outputs for that case so is + automagically selected + """ + scl = " ".join(self.cl) + err = None + if self.args.parampass != "0": + if os.path.exists(self.elog): + ste = open(self.elog, "a") + else: + ste = open(self.elog, "w") + if self.lastclredirect: + sto = open(self.lastclredirect[1], "wb") # is name of an output file + else: + if os.path.exists(self.tlog): + sto = open(self.tlog, "a") + else: + sto = open(self.tlog, "w") + sto.write( + "## Executing Toolfactory generated command line = %s\n" % scl + ) + sto.flush() + subp = subprocess.run( + self.cl, env=self.ourenv, shell=False, stdout=sto, stderr=ste + ) + sto.close() + ste.close() + retval = subp.returncode + else: # work around special case - stdin and write to stdout + if len(self.infiles) > 0: + sti = open(self.infiles[0][IPATHPOS], "rb") + else: + sti = sys.stdin + if len(self.outfiles) > 0: + sto = open(self.outfiles[0][ONAMEPOS], "wb") + else: + sto = sys.stdout + subp = subprocess.run( + self.cl, env=self.ourenv, shell=False, stdout=sto, stdin=sti + ) + sto.write("## Executing Toolfactory generated command line = %s\n" % scl) + retval = subp.returncode + sto.close() + sti.close() + if os.path.isfile(self.tlog) and os.stat(self.tlog).st_size == 0: + os.unlink(self.tlog) + if os.path.isfile(self.elog) and os.stat(self.elog).st_size == 0: + os.unlink(self.elog) + if retval != 0 and err: # problem + sys.stderr.write(err) + logging.debug("run done") + return retval + + def copy_to_container(self, src, dest, container): + """Recreate the src directory tree at dest - full path included""" + idir = os.getcwd() + workdir = os.path.dirname(src) + os.chdir(workdir) + _, tfname = tempfile.mkstemp(suffix=".tar") + tar = tarfile.open(tfname, mode="w") + srcb = os.path.basename(src) + tar.add(srcb) + tar.close() + data = open(tfname, "rb").read() + container.put_archive(dest, data) + os.unlink(tfname) + os.chdir(idir) + + def copy_from_container(self, src, dest, container): + """recreate the src directory tree at dest using docker sdk""" + os.makedirs(dest, exist_ok=True) + _, tfname = tempfile.mkstemp(suffix=".tar") + tf = open(tfname, "wb") + bits, stat = container.get_archive(src) + for chunk in bits: + tf.write(chunk) + tf.close() + tar = tarfile.open(tfname, "r") + tar.extractall(dest) + tar.close() + os.unlink(tfname) + + def planemo_biodocker_test(self): + """planemo currently leaks dependencies if used in the same container and gets unhappy after a + first successful run. https://github.com/galaxyproject/planemo/issues/1078#issuecomment-731476930 + + Docker biocontainer has planemo with caches filled to save repeated downloads + + + """ + + def prun(container, tout, cl, user="biodocker"): + rlog = container.exec_run(cl, user=user) + slogl = str(rlog).split("\\n") + slog = "\n".join(slogl) + tout.write(f"## got rlog {slog} from {cl}\n") + + if os.path.exists(self.tlog): + tout = open(self.tlog, "a") + else: + tout = open(self.tlog, "w") + planemoimage = "quay.io/fubar2/planemo-biocontainer" + xreal = "%s.xml" % self.tool_name + repname = f"{self.tool_name}_planemo_test_report.html" + ptestrep_path = os.path.join(self.repdir, repname) + client = docker.from_env() + tvol = client.volumes.create() + tvolname = tvol.name + destdir = "/toolfactory/ptest" + imrep = os.path.join(destdir, repname) + # need to keep the container running so keep it open with sleep + # will stop and destroy it when we are done + container = client.containers.run( + planemoimage, + "sleep 120m", + detach=True, + user="biodocker", + volumes={f"{tvolname}": {"bind": "/toolfactory", "mode": "rw"}}, + ) + cl = f"mkdir -p {destdir}" + prun(container, tout, cl, user="root") + # that's how hard it is to get root on a biodocker container :( + cl = f"rm -rf {destdir}/*" + prun(container, tout, cl, user="root") + ptestpath = os.path.join(destdir, "tfout", xreal) + self.copy_to_container(self.tooloutdir, destdir, container) + cl = "chown -R biodocker /toolfactory" + prun(container, tout, cl, user="root") + _ = container.exec_run(f"ls -la {destdir}") + ptestcl = f"planemo test --update_test_data --no_cleanup --test_data {destdir}/tfout/test-data --galaxy_root /home/biodocker/galaxy-central {ptestpath}" + try: + _ = container.exec_run(ptestcl) + # fails because test outputs missing but updates the test-data directory + except Error: + e = sys.exc_info()[0] + tout.write(f"#### error: {e} from {ptestcl}\n") + cl = f"planemo test --test_output {imrep} --no_cleanup --test_data {destdir}/tfout/test-data --galaxy_root /home/biodocker/galaxy-central {ptestpath}" + try: + prun(container, tout, cl) + except Error: + e = sys.exc_info()[0] + tout.write(f"#### error: {e} from {ptestcl}\n") + testouts = tempfile.mkdtemp(suffix=None, prefix="tftemp", dir=".") + self.copy_from_container(destdir, testouts, container) + src = os.path.join(testouts, "ptest") + if os.path.isdir(src): + shutil.copytree(src, ".", dirs_exist_ok=True) + src = repname + if os.path.isfile(repname): + shutil.copyfile(src, ptestrep_path) + else: + tout.write(f"No output from run to shutil.copytree in {src}\n") + tout.close() + container.stop() + container.remove() + tvol.remove() + shutil.rmtree(testouts) # leave for debugging + + def shedLoad(self): + """ + use bioblend to create new repository + or update existing + + """ + if os.path.exists(self.tlog): + sto = open(self.tlog, "a") + else: + sto = open(self.tlog, "w") + + ts = toolshed.ToolShedInstance( + url=self.args.toolshed_url, key=self.args.toolshed_api_key, verify=False + ) + repos = ts.repositories.get_repositories() + rnames = [x.get("name", "?") for x in repos] + rids = [x.get("id", "?") for x in repos] + tfcat = "ToolFactory generated tools" + if self.tool_name not in rnames: + tscat = ts.categories.get_categories() + cnames = [x.get("name", "?").strip() for x in tscat] + cids = [x.get("id", "?") for x in tscat] + catID = None + if tfcat.strip() in cnames: + ci = cnames.index(tfcat) + catID = cids[ci] + res = ts.repositories.create_repository( + name=self.args.tool_name, + synopsis="Synopsis:%s" % self.args.tool_desc, + description=self.args.tool_desc, + type="unrestricted", + remote_repository_url=self.args.toolshed_url, + homepage_url=None, + category_ids=catID, + ) + tid = res.get("id", None) + sto.write(f"#create_repository {self.args.tool_name} tid={tid} res={res}\n") + else: + i = rnames.index(self.tool_name) + tid = rids[i] + try: + res = ts.repositories.update_repository( + id=tid, tar_ball_path=self.newtarpath, commit_message=None + ) + sto.write(f"#update res id {id} ={res}\n") + except ConnectionError: + sto.write( + "####### Is the toolshed running and the API key correct? Bioblend shed upload failed\n" + ) + sto.close() + + def eph_galaxy_load(self): + """ + use ephemeris to load the new tool from the local toolshed after planemo uploads it + """ + if os.path.exists(self.tlog): + tout = open(self.tlog, "a") + else: + tout = open(self.tlog, "w") + cll = [ + "shed-tools", + "install", + "-g", + self.args.galaxy_url, + "--latest", + "-a", + self.args.galaxy_api_key, + "--name", + self.tool_name, + "--owner", + "fubar", + "--toolshed", + self.args.toolshed_url, + "--section_label", + "ToolFactory", + ] + tout.write("running\n%s\n" % " ".join(cll)) + subp = subprocess.run( + cll, env=self.ourenv, cwd=self.ourcwd, shell=False, stderr=tout, stdout=tout + ) + tout.write( + "installed %s - got retcode %d\n" % (self.tool_name, subp.returncode) + ) + tout.close() + return subp.returncode + + def writeShedyml(self): + """for planemo""" + yuser = self.args.user_email.split("@")[0] + yfname = os.path.join(self.tooloutdir, ".shed.yml") + yamlf = open(yfname, "w") + odict = { + "name": self.tool_name, + "owner": yuser, + "type": "unrestricted", + "description": self.args.tool_desc, + "synopsis": self.args.tool_desc, + "category": "TF Generated Tools", + } + yaml.dump(odict, yamlf, allow_unicode=True) + yamlf.close() + + def makeTool(self): + """write xmls and input samples into place""" + self.makeXML() + if self.args.script_path: + stname = os.path.join(self.tooloutdir, "%s" % (self.sfile)) + if not os.path.exists(stname): + shutil.copyfile(self.sfile, stname) + xreal = "%s.xml" % self.tool_name + xout = os.path.join(self.tooloutdir, xreal) + shutil.copyfile(xreal, xout) + for p in self.infiles: + pth = p[IPATHPOS] + dest = os.path.join(self.testdir, "%s_sample" % p[ICLPOS]) + shutil.copyfile(pth, dest) + + def makeToolTar(self): + """move outputs into test-data and prepare the tarball""" + excludeme = "_planemo_test_report.html" + + def exclude_function(tarinfo): + filename = tarinfo.name + return None if filename.endswith(excludeme) else tarinfo + + if os.path.exists(self.tlog): + tout = open(self.tlog, "a") + else: + tout = open(self.tlog, "w") + for p in self.outfiles: + oname = p[ONAMEPOS] + tdest = os.path.join(self.testdir, "%s_sample" % oname) + if not os.path.isfile(tdest): + src = os.path.join(self.testdir, oname) + if os.path.isfile(src): + shutil.copyfile(src, tdest) + dest = os.path.join(self.repdir, "%s.sample" % (oname)) + shutil.copyfile(src, dest) + else: + tout.write( + "###Output file %s not found in testdir %s. This is normal during the first Planemo run that generates test outputs" + % (tdest, self.testdir) + ) + tf = tarfile.open(self.newtarpath, "w:gz") + tf.add(name=self.tooloutdir, arcname=self.tool_name, filter=exclude_function) + tf.close() + shutil.copyfile(self.newtarpath, self.args.new_tool) + + def moveRunOutputs(self): + """need to move planemo or run outputs into toolfactory collection""" + with os.scandir(self.tooloutdir) as outs: + for entry in outs: + if not entry.is_file(): + continue + if "." in entry.name: + nayme, ext = os.path.splitext(entry.name) + if ext in [".yml", ".xml", ".json", ".yaml"]: + ext = f"{ext}.txt" + else: + ext = ".txt" + ofn = "%s%s" % (entry.name.replace(".", "_"), ext) + dest = os.path.join(self.repdir, ofn) + src = os.path.join(self.tooloutdir, entry.name) + shutil.copyfile(src, dest) + with os.scandir(self.testdir) as outs: + for entry in outs: + if ( + (not entry.is_file()) + or entry.name.endswith("_sample") + or entry.name.endswith("_planemo_test_report.html") + ): + continue + if "." in entry.name: + nayme, ext = os.path.splitext(entry.name) + else: + ext = ".txt" + newname = f"{entry.name}{ext}" + dest = os.path.join(self.repdir, newname) + src = os.path.join(self.testdir, entry.name) + shutil.copyfile(src, dest) + + +def main(): + """ + This is a Galaxy wrapper. It expects to be called by a special purpose tool.xml + + """ + parser = argparse.ArgumentParser() + a = parser.add_argument + a("--script_path", default=None) + a("--history_test", default=None) + a("--cl_prefix", default=None) + a("--sysexe", default=None) + a("--packages", default=None) + a("--tool_name", default="newtool") + a("--tool_dir", default=None) + a("--input_files", default=[], action="append") + a("--output_files", default=[], action="append") + a("--user_email", default="Unknown") + a("--bad_user", default=None) + a("--make_Tool", default="runonly") + a("--help_text", default=None) + a("--tool_desc", default=None) + a("--tool_version", default=None) + a("--citations", default=None) + a("--command_override", default=None) + a("--test_override", default=None) + a("--additional_parameters", action="append", default=[]) + a("--edit_additional_parameters", action="store_true", default=False) + a("--parampass", default="positional") + a("--tfout", default="./tfout") + a("--new_tool", default="new_tool") + a("--galaxy_url", default="http://localhost:8080") + a("--toolshed_url", default="http://localhost:9009") + # make sure this is identical to tool_sheds_conf.xml localhost != 127.0.0.1 so validation fails + a("--toolshed_api_key", default="fakekey") + a("--galaxy_api_key", default="fakekey") + a("--galaxy_root", default="/galaxy-central") + a("--galaxy_venv", default="/galaxy_venv") + args = parser.parse_args() + assert not args.bad_user, ( + 'UNAUTHORISED: %s is NOT authorized to use this tool until Galaxy admin adds %s to "admin_users" in the galaxy.yml Galaxy configuration file' + % (args.bad_user, args.bad_user) + ) + assert args.tool_name, "## Tool Factory expects a tool name - eg --tool_name=DESeq" + assert ( + args.sysexe or args.packages + ), "## Tool Factory wrapper expects an interpreter or an executable package" + args.input_files = [x.replace('"', "").replace("'", "") for x in args.input_files] + # remove quotes we need to deal with spaces in CL params + for i, x in enumerate(args.additional_parameters): + args.additional_parameters[i] = args.additional_parameters[i].replace('"', "") + r = ScriptRunner(args) + r.writeShedyml() + r.makeTool() + if args.make_Tool == "generate": + _ = r.run() # for testing toolfactory itself + r.moveRunOutputs() + r.makeToolTar() + else: + r.planemo_biodocker_test() # test to make outputs and then test + r.moveRunOutputs() + r.makeToolTar() + if args.make_Tool == "gentestinstall": + r.shedLoad() + r.eph_galaxy_load() + + +if __name__ == "__main__": + main()
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/rgToolFactory2.xml Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,539 @@ +<tool id="rgtfd" name="toolfactory" version="2.00" profile="16.04" > + <description>Scripts into tools v2.0</description> + <macros> + <xml name="tool_metadata"> + <param name="tool_version" label="Tool Version - bump this to warn users trying to redo old analyses" type="text" value="0.01" + help="If you change your script and regenerate the 'same' tool, you should inform Galaxy (and users) by changing (bumping is traditional) this number"/> + <param name="tool_desc" label="Tool Synopsis" type="text" value="" + help="Supply a brief tool description for the Galaxy tool menu entry" /> + <param name="help_text" label="Tool form documentation and help text for users" type="text" area="true" + value="**What it Does**" + help="Supply user documentation to appear on the new tool form as reStructured text - http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html" > + <sanitizer> + <valid initial="string.printable" /> + <mapping initial="none"/> + </sanitizer> + </param> + <repeat name="citations" title="Citation"> + <conditional name="citation_type"> + <param name="type" type="select" display="radio" label="Citation Type"> + <option value="doi">DOI</option> + <option value="bibtex">BibTeX</option> + </param> + <when value="doi"> + <param name="doi" label="DOI" type="text" value="" + help="Supply a DOI (e.g. doi: 10.1111/j.1740-9713.2007.00258.x) to be cited when this tool is used in published research." /> + </when> + <when value="bibtex"> + <param name="bibtex" label="BibTex" type="text" area="true" + help="Supply a BibTex entry that should be cited when this tool is used in published research." value="" > + <sanitizer> + <valid initial="string.printable" /> + <mapping initial="none"/> + </sanitizer> + </param> + </when> + </conditional> + </repeat> + </xml> + <xml name="io"> + <section name="io" title="Input and output files" expanded="true"> + <repeat name="history_inputs" title="zero or more input data files to pass as parameters to the executable." + help="USE SMALL SAMPLES for the new tool's test. Prompts will form a history item selector as input for users of this new tool"> + <param name="input_files" type="data" format="data" label="Select an input file from your history" optional="true" multiple="false" + help=""/> + <param name="input_formats" type="select" multiple="true" label="Select the datatype(s) that your tool/script accepts as input" + help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular"> + <options from_parameter="tool.app.datatypes_registry.upload_file_formats"> + <column name="value" index="0"/> + </options> + </param> + <param name="input_label" type="text" value="" label="This will become the user prompt for the form so please make it informative" + help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" > + <sanitizer invalid_char=""> + <valid initial="string.printable"> + <remove value='~~~' /> + </valid> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="input_help" type="text" value="" label="This will become help text on the form." + help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation"> + <sanitizer invalid_char=""> + <valid initial="string.printable"> + <remove value='~~~' /> + </valid> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="input_CL" type="text" label="Positional: ordinal integer. Argparse: argument name. STDIN if the executable/script expects it" + help="If you will pass positional parameters, enter the integer ordinal for this parameter. If Argparse style, '--' will be prepended or '-' if single character" value=""> + </param> + </repeat> + <repeat name="history_outputs" title="one or more new history items output by the executable to appear in the user history after the tool runs" + help="The name will become a history item for users of the new tool you are making containing one of it's outputs"> + <param name="history_name" type="text" label="Name for this output to appear in new history" optional="false" + help="No spaces! Argparse will also use this name as --[name]"> + <sanitizer invalid_char="_"> + <valid initial="string.ascii_letters,string.digits" > + <add value="_" /> + </valid> + </sanitizer> + </param> + <param name="history_format" type="select" multiple="false" label="Select the datatype for this output" + help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular"> + <options from_parameter="tool.app.datatypes_registry.upload_file_formats"> + <column name="value" index="0"/> + </options> + </param> + <param name="history_CL" type="text" label="Positional: ordinal integer. Use STDOUT if '>' required. Otherwise ignored if argparse because name is used" + help="If positional parameters, enter the integer ordinal expected for this parameter. If argparse, ignore unless STDOUT needed" value=""/> + <param name="history_test" type="text" label="Test pass decision criterion for this output compared to test generation" + help="Available options are diff:[lines], sim_size:[delta (integer) or delta_frac (float)" value="diff:0"/> + </repeat> + </section> + </xml> + <xml name="additparam"> + <section name="addparam" title="Executable or script settings passed on the command line other than I/O files" expanded="true"> + <param name="edit_params" type="select" display="radio" label="Make these settings on the generated tool form user editable?" + help="If no, users will NOT be able to alter any additional parameters. If yes, these will appear on the tool form as text fields with no validation or sanitizing"> + <option value="yes" selected="true">Yes, allow user to edit all additional parameters on the generated tool form</option> + <option value="no">No - use the fixed values for all additional parameters - no user editing</option> + </param> + + <repeat name="additional_parameters" title="zero or more settings to be set by the tool user and passed on the command line" + help="See examples below to see how these can be parsed by scripts in the various languages"> + <param name="param_name" type="text" value="" label="Choose the name for this parameter - MUST not be blank!"> + <sanitizer invalid_char=""> + <valid initial="string.ascii_letters,string.digits"/> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="param_type" type="select" label="Select the type for this parameter"> + <option value="text" selected="true">text</option> + <option value="integer">integer</option> + <option value="float">float</option> + </param> + <param name="param_value" type="text" value="" label="Enter this parameter's default value" + help="Note that '~~~' is an internal delimiter must not appear in this text field - please work around this technical limitation" > + <sanitizer invalid_char=""> + <valid initial="string.printable"> + <remove value='~~~' /> + </valid> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="param_label" type="text" value="" label="Enter this parameter's label for the form" + help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" > + <sanitizer invalid_char=""> + <valid initial="string.printable"> + <remove value='~~~'/> + </valid> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="param_help" type="text" value="" label="Help for this parameter" + help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation" > + <sanitizer invalid_char=""> + <valid initial="string.printable"> + <remove value='~~~'/> + </valid> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="param_CL" type="text" label="Positional ordinal | argparse argument name" + help="Using positional parameters, enter the integer ordinal for this parameter on the command line. Using Argparse style, '--' will be prepended on the CL" value="" /> + <param name="param_CLprefixed" type="text" label="Override the generated default argparse name prefix if not empty - eg ----foo if needed" + help="Some targets like Planemo expect an unadorned action like 'test' before --galaxy_root." value="" /> + </repeat> + </section> + </xml> + </macros> + +<requirements> + <requirement type="package" version="0.4.11">galaxyxml</requirement> + <requirement type="package" version="0.14.0">bioblend</requirement> + <requirement type="package" version="0.10.6">ephemeris</requirement> + <requirement type="package" version="4.4.0">docker-py</requirement> + <container type="docker">quay.io/fubar2/planemo-biocontainer:latest</container> +</requirements> + + <command ><![CDATA[ +#import os +#set dev_env = os.environ.get('GALAXY_DEVELOPMENT_ENVIRONMENT', '0') == '1' +#if not $dev_env and ( $__user_email__ not in $__admin_users__ ): +python3 $__tool_directory__/rgToolFactory2.py --bad_user $__user_email__ + #else: +python3 $__tool_directory__/rgToolFactory2.py + #if len(str($cl_prefix)) > 3: +--cl_prefix "$cl_prefix" + #end if + #if $cover.commover == "yes": + #if len(str($cover.command_override)) > 10: +--command_override "$commandoverride" + #end if + #if len(str($cover.test_override)) > 10: +--test_override "$testoverride" + #end if + #end if +--packages "$deps.packages" + #if $deps.usescript.choosescript == "yes": +--script_path "$runme" +--sysexe "$deps.usescript.scriptrunner" + #end if +--tool_name "$tool_name" --user_email "$__user_email__" --citations "$citeme" --parampass "$io_param.ppass.parampass" + + #if str($make.makeMode.make_Tool)!="runonly": +--make_Tool "$make.makeMode.make_Tool" +--tool_desc "$make.makeMode.tool_desc" +--tool_version "$make.makeMode.tool_version" +--help_text "$helpme" +--new_tool "$new_tool" +--toolshed_api_key "$make.makeMode.toolshed_apikey" +--galaxy_api_key "$make.makeMode.galaxy_apikey" +--toolshed_url "$make.makeMode.toolshed_url" +--galaxy_url "$make.makeMode.galaxy_url" + #end if + #if $io_param.ppass.parampass != '0': + #if str($io_param.ppass.addparam.edit_params) == "yes": +--edit_additional_parameters + #end if + #for apar in $io_param.ppass.addparam.additional_parameters: +--additional_parameters "$apar.param_name~~~$apar.param_value~~~$apar.param_label~~~$apar.param_help~~~$apar.param_type~~~$apar.param_CL~~~$apar.param_CLprefixed" + #end for + #end if + #for $intab in $io_param.ppass.io.history_inputs: +--input_files "$intab.input_files~~~$intab.input_CL~~~$intab.input_formats~~~$intab.input_label~~~$intab.input_help" + #end for + #for $otab in $io_param.ppass.io.history_outputs: +--output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL~~~$otab.history_test" + #end for +--galaxy_root "$__root_dir__" +--tool_dir "$__tool_directory__" + #end if +]]></command> + <configfiles> + <configfile name="runme"> +$deps.usescript.dynScript + </configfile> + <configfile name="commandoverride"> +#if $cover.commover == "yes" and len(str($cover.command_override).strip()) > 1: +$cover.command_override +#end if + </configfile> + <configfile name="testoverride"> +#if $cover.commover == "yes" and len(str($cover.test_override).strip()) > 1: +$cover.test_override +#end if + </configfile> + <configfile name="helpme"> + #if $make.makeMode.make_Tool != "runonly": +${make.makeMode.help_text} + #else +$tool_name help goes here + #end if + </configfile> + <configfile name="citeme"> +#if $make.makeMode.make_Tool != "runonly": + #for $citation in $make.makeMode.citations: + #if $citation.citation_type.type == "bibtex": + **ENTRY**bibtex + ${citation.citation_type.bibtex} + #else + **ENTRY**doi + ${citation.citation_type.doi} + #end if + #end for +#end if + </configfile> + </configfiles> + <inputs> + <param name="tool_name" type="text" value="tool1" label="New tool ID and title for outputs" + help="Toolshed repository name. Choose thoughtfully to avoid namespace clashes with other tool writers. Lower case, digits and underscores only"> + <sanitizer invalid_char=""> + <valid initial="string.ascii_lowercase,string.digits"> + <add value="_"/> + </valid> + </sanitizer> + </param> + + <section name="deps" title="Dependencies, optional script and script interpreter" expanded="true"> + + <param name="packages" type="text" value="" label="Conda dependencies as package name[:version, name:version...]. These will always be available when this tool executes" + optional="false" help="Use =[ver] or :[ver] for specific version - 'bwa=0.17.0'. Default is latest. Will be used every time the tool is (re)run. Only Conda is currently supported" /> + + <conditional name="usescript"> + <param name="choosescript" type="select" display="radio" label="Supply a script for a dependency (e.g. python/R/bash) or a system executable such as Bash" + help = "For script interpreters like Python or bash, parameters and i/o specified below must match script's expectations - if you pass parameters, the script must deal with them"> + <option value="no">No script required for this tool - just pass parameters on the command line to the first dependency listed above</option> + <option value="yes" selected="true">Yes, a script is ready to be pasted below</option> + </param> + <when value="no"> + <param name="dynScript" type="hidden" value="" /> + <param name="scriptrunner" type="hidden" value="" /> + </when> + <when value="yes"> + <param name="scriptrunner" type="text" value="" label="Interpreter for the script - eg bash or python. Can be one of the dependencies named above or a system executable" + help="Scripts are interpreted by the executable named here. Use bash for bash scripts, or a conda dependency such as R or Python for those scripts"> + <sanitizer invalid_char=""> + <valid initial="string.ascii_letters,string.digits"> + <add value="_"/> + </valid> + </sanitizer> + </param> + <param name="dynScript" type="text" area="True" value="" label="Script for executable above to interpret. It can be one of the Conda dependency names " + help="Script must handle all i/o and parameters as specified below using the parameters and passing method chosen below"> + <sanitizer> + <valid initial="string.printable"/> + <mapping initial="none"/> + </sanitizer> + </param> + </when> + </conditional> + </section> + <section name="io_param" title="Data file input, output and settings forming the executable or script command line" expanded="true"> + <conditional name="ppass"> + <param name="parampass" type="select" display="radio" label="Command line parameter passing method to use"> + <option value="argparse" selected="true">Argparse: passed in the form of --clname value</option> + <option value="positional">Positional: Passed in the order of positional ordinals ...foo.bam bar.idx zot.xls</option> + <option value="0">Tool reads selected input file from STDIN and writes STDOUT with no parameters</option> + </param> + <when value="argparse"> + <expand macro="io" /> + <expand macro="additparam" /> + </when> + <when value="positional"> + <expand macro="io" /> + <expand macro="additparam" /> + </when> + <when value="0"> + <expand macro="io"/> + </when> + </conditional> + </section> + <param name="cl_prefix" type="text" value="" label="Prefix for generated command line. Prepends generated i/o and parameter CL. Use override below to replace completely" + help="Text will replace generated executable/script elements. Sometimes required before i/o and parameters in the generated command line." /> + <conditional name="cover"> + <param name="commover" type="select" display="radio" label="Add Human wrought code to override the generated XML command and/or test section - DIY" + help = "For arbitrary and artfull command lines. All i/o and parameters must be passed. Choose No unless needed. Not for the faint of heart"> + <option value="no" selected="true">No. Use automatically generated command/test XML </option> + <option value="yes">Yes. XML needed to override autogenerated command and/or test segments will be pasted below</option> + </param> + <when value="no"> + <param name="command_override" type="hidden" value="" /> + <param name="test_override" type="hidden" value="" /> + </when> + <when value="yes"> + <param name="command_override" type="text" area="True" value="" label="Optional. Human wrought command element override XML/template - e.g. for bwa" + help="For arbitrary and artfull command lines. All i/o and parameters must be passed. Leave blank unless needed. Not for the faint of heart"> + <sanitizer> + <valid initial="string.printable"/> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="test_override" type="text" area="True" value="" label="Optional. Human wrought test element override XML/template - e.g. for bwa" + help="For arbitrary and artfull scripts. Leave blank unless needed. Not for the faint of heart"> + <sanitizer> + <valid initial="string.printable" /> + <mapping initial="none"/> + </sanitizer> + </param> + </when> + </conditional> + <section name="make" title="Generate, toolshed and local Galaxy installation options" expanded="true"> + <conditional name="makeMode"> + <param name="make_Tool" type="select" display="radio" label="Choose the steps you want to run. The TF Docker container is recommended for local installation" + help="Installation in this Galaxy is optional" > + <option value="generate" >Run to generate tests only. Should fail if dependencies needed.</option> + <option value="gentest">Test with planemo after generating.</option> + <option value="gentestinstall" selected="true">Install in this Galaxy after generation and testing. Must have local ToolShed as in the TF Docker container</option> + </param> + <when value="generate"> + <param name="galaxy_apikey" value="" type="hidden" ></param> + <param name="toolshed_apikey" value="" type="hidden" ></param> + <param name="galaxy_url" value="" type="hidden" ></param> + <param name="toolshed_url" value="" type="hidden" ></param> + <expand macro="tool_metadata" /> + </when> + <when value="gentest"> + <param name="galaxy_apikey" value="" type="hidden" ></param> + <param name="toolshed_apikey" value="" type="hidden" ></param> + <param name="galaxy_url" value="" type="hidden" ></param> + <param name="toolshed_url" value="" type="hidden" ></param> + <expand macro="tool_metadata" /> + </when> + <when value="gentestinstall"> + <param name="galaxy_url" type="text" value="http://localhost:8080" label="URL for the Galaxy server where the new tool should be installed" + help="Default is localhost"> + <sanitizer> + <valid initial="string.printable" /> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="galaxy_apikey" type="text" value="fakekey" label="API key for the Galaxy to install the new tool" + help="Cut and paste from the admin user properties screen"> + <sanitizer> + <valid initial="string.ascii_letters,string.digits" /> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="toolshed_url" type="text" value="http://localhost:9009" label="URL for the Toolshed where the new tool should be installed" + help="Default value is localhost:9009"> + <sanitizer> + <valid initial="string.printable" /> + <mapping initial="none"/> + </sanitizer> + </param> + <param name="toolshed_apikey" type="text" value="fakekey" label="API key for the local toolshed to use when installing the tool" + help="Cut and paste from the admin user properties screen"> + <sanitizer> + <valid initial="string.ascii_letters,string.digits" /> + <mapping initial="none"/> + </sanitizer> + </param> + <expand macro="tool_metadata" /> + </when> + </conditional> + </section> + </inputs> + <outputs> + + <data format="tgz" name="new_tool" label="${tool_name}_toolshed.tgz" > + <filter>makeMode['make_Tool'] != "runonly"</filter> + </data> + + <collection name="TF_run_report" type="list" label="${tool_name} outputs"> + <discover_datasets pattern="__name_and_ext__" directory="TF_run_report_tempdir" /> + </collection> + </outputs> +<tests> +<test> + <param name="user_email" value="admin@galaxy.org"/> + <param name="input_files" value="input1_sample" /> + <param name="input_CL" value="1" /> + <param name="input_formats" value="txt" /> + <param name="input_label" value="input" /> + <param name="input_help" value="help" /> + <param name="tool_name" value="pyrevpos" /> + <param name="parampass" value="positional" /> + <param name="make_Tool" value="generate" /> + <param name="tool_version" value="0.01" /> + <param name="tool_desc" value="positional reverse" /> + <param name="help_text" value="help text goes here" /> + <param name="packages" value="python"/> + <param name="history_name" value="output2" /> + <param name="history_format" value="txt" /> + <param name="history_CL" value="2" /> + <param name="dynScript" value="import sys; inp = sys.argv[1]; outp = sys.argv[2]; inlist = open(inp,'r').readlines(); o = open(outp,'w'); rs = [''.join(list(reversed(x.rstrip()))) for x in inlist]; o.write('\n'.join(rs)); o.close()"/> + <param name="choosescript" value="yes" /> + <param name="script_path" value="$runme"/> + <output name="new_tool" file="toolfactory_pyrevpos_tgz_sample" compare="sim_size" delta="6000" /> +</test> +</tests> +<help> + +.. class:: warningmark + +**Details and attribution** +(see GTF_) + +**Local Admins ONLY** +Only users whose IDs found in the local admin_user configuration setting in universe_wsgi.ini can run this tool. + +**If you find a bug** +Please raise an issue, or even better, submit a pull request fixing it, on the github repository GTF_ + +**What it does** +This tool optionally generates normal workflow compatible first class Galaxy tools + +Generated tools can run existing binary packages that become requirements, existing scripts, or new scripts pasted into this tool form. +Pasted scripts are written so they are part of the new tool and cannot be adjusted by the downstream user. +Binary packages are managed by the dependency subsystem - conda usually, so anything in bioconda or conda_forge is available for example. + +Any number of parameters can be built into the new tool form for passing in to the script or executable at runtime. +These can be editable by the downstream user or baked in. + +When you run this tool, your executable or script and supplied parameter values will be run to produce a canonical +set of outputs - these are used to construct a test for the new tool. + +If tool generation is required, a new tarball compatible with any Galaxy toolshed is created. +It can be unpacked in your galaxy/tools directory and manually added to tool_conf.xml, or +installed into any toolshed from where it can be installed into your Galaxy. + + +.. class:: warningmark + +**Note to system administrators** +This tool offers *NO* built in protection against malicious scripts. It should only be installed on private/personnal Galaxy instances. +Admin_users will have the power to do anything they want as the Galaxy user if you install this tool. + +.. class:: warningmark + +**Use on public servers** is STRONGLY discouraged for obvious reasons + +The tools generated by this tool will run just as securely as any other normal installed Galaxy tool but like any other new tools, should always be checked carefully before installation. +We recommend that you follow the good code hygiene practices associated with safe toolshed practices. + +Here's a sample python script that can be cut and pasted into the tool form, suitable for positional parameter passing: + +:: + + # reverse order of text by row + import sys + inp = sys.argv[1] + outp = sys.argv[2] + i = open(inp,'r').readlines() + o = open(outp,'w') + for row in i: + rs = row.rstrip() + rs = list(rs) + rs.reverse() + o.write(''.join(rs)) + o.write('\n') + o.close() + +With argparse style parameters: + +:: + + # reverse order of text by row + import argparse + parser = argparse.ArgumentParser() + a = parser.add_argument + a('--infile',default='') + a('--outfile',default=None) + args = parser.parse_args() + inp = args.infile + outp = args.outfile + i = open(inp,'r').readlines() + o = open(outp,'w') + for row in i: + rs = row.rstrip() + rs = list(rs) + rs.reverse() + o.write(''.join(rs)) + o.write('\n') + o.close() + + + +Paper_ + +*Licensing* + +Copyright Ross Lazarus (ross period lazarus at gmail period com) May 2012 +All rights reserved. +Licensed under the LGPL_ + +.. _LGPL: http://www.gnu.org/copyleft/lesser.html +.. _GTF: https://github.com/fubar2/toolfactory +.. _Paper: http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573 + + +</help> +<citations> + <citation type="doi">10.1093/bioinformatics/bts573</citation> +</citations> +</tool> + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/test-data/input1_sample Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,166 @@ +*WARNING before you start* + + Install this tool on a private Galaxy ONLY + Please NEVER on a public or production instance + +Updated august 2014 by John Chilton adding citation support + +Updated august 8 2014 to fix bugs reported by Marius van den Beek + +Please cite the resource at +http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref +if you use this tool in your published work. + +**Short Story** + +This is an unusual Galaxy tool capable of generating new Galaxy tools. +It works by exposing *unrestricted* and therefore extremely dangerous scripting +to all designated administrators of the host Galaxy server, allowing them to +run scripts in R, python, sh and perl over multiple selected input data sets, +writing a single new data set as output. + +*You have a working r/python/perl/bash script or any executable with positional or argparse style parameters* + +It can be turned into an ordinary Galaxy tool in minutes, using a Galaxy tool. + + +**Automated generation of new Galaxy tools for installation into any Galaxy** + +A test is generated using small sample test data inputs and parameter settings you supply. +Once the test case outputs have been produced, they can be used to build a +new Galaxy tool. The supplied script or executable is baked as a requirement +into a new, ordinary Galaxy tool, fully workflow compatible out of the box. +Generated tools are installed via a tool shed by an administrator +and work exactly like all other Galaxy tools for your users. + +**More Detail** + +To use the ToolFactory, you should have prepared a script to paste into a +text box, or have a package in mind and a small test input example ready to select from your history +to test your new script. + +```planemo test rgToolFactory2.xml --galaxy_root ~/galaxy --test_data ~/galaxy/tools/tool_makers/toolfactory/test-data``` works for me + +There is an example in each scripting language on the Tool Factory form. You +can just cut and paste these to try it out - remember to select the right +interpreter please. You'll also need to create a small test data set using +the Galaxy history add new data tool. + +If the script fails somehow, use the "redo" button on the tool output in +your history to recreate the form complete with broken script. Fix the bug +and execute again. Rinse, wash, repeat. + +Once the script runs sucessfully, a new Galaxy tool that runs your script +can be generated. Select the "generate" option and supply some help text and +names. The new tool will be generated in the form of a new Galaxy datatype +*toolshed.gz* - as the name suggests, it's an archive ready to upload to a +Galaxy ToolShed as a new tool repository. + +Once it's in a ToolShed, it can be installed into any local Galaxy server +from the server administrative interface. + +Once the new tool is installed, local users can run it - each time, the script +that was supplied when it was built will be executed with the input chosen +from the user's history. In other words, the tools you generate with the +ToolFactory run just like any other Galaxy tool,but run your script every time. + +Tool factory tools are perfect for workflow components. One input, one output, +no variables. + +*To fully and safely exploit the awesome power* of this tool, +Galaxy and the ToolShed, you should be a developer installing this +tool on a private/personal/scratch local instance where you are an +admin_user. Then, if you break it, you get to keep all the pieces see +https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home + +**Installation** +This is a Galaxy tool. You can install it most conveniently using the +administrative "Search and browse tool sheds" link. Find the Galaxy Main +toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory +repository. Open it and review the code and select the option to install it. + +If you can't get the tool that way, the xml and py files here need to be +copied into a new tools +subdirectory such as tools/toolfactory Your tool_conf.xml needs a new entry +pointing to the xml +file - something like:: + + <section name="Tool building tools" id="toolbuilders"> + <tool file="toolfactory/rgToolFactory.xml"/> + </section> + +If not already there, +please add: +<datatype extension="toolshed.gz" type="galaxy.datatypes.binary:Binary" +mimetype="multipart/x-gzip" subclass="True" /> +to your local data_types_conf.xml. + + +**Restricted execution** + +The tool factory tool itself will then be usable ONLY by admin users - +people with IDs in admin_users in universe_wsgi.ini **Yes, that's right. ONLY +admin_users can run this tool** Think about it for a moment. If allowed to +run any arbitrary script on your Galaxy server, the only thing that would +impede a miscreant bent on destroying all your Galaxy data would probably +be lack of appropriate technical skills. + +**What it does** + +This is a tool factory for simple scripts in python, R and +perl currently. Functional tests are automatically generated. How cool is that. + +LIMITED to simple scripts that read one input from the history. Optionally can +write one new history dataset, and optionally collect any number of outputs +into links on an autogenerated HTML index page for the user to navigate - +useful if the script writes images and output files - pdf outputs are shown +as thumbnails and R's bloated pdf's are shrunk with ghostscript so that and +imagemagik need to be available. + +Generated tools can be edited and enhanced like any Galaxy tool, so start +small and build up since a generated script gets you a serious leg up to a +more complex one. + +**What you do** + +You paste and run your script, you fix the syntax errors and +eventually it runs. You can use the redo button and edit the script before +trying to rerun it as you debug - it works pretty well. + +Once the script works on some test data, you can generate a toolshed compatible +gzip file containing your script ready to run as an ordinary Galaxy tool in +a repository on your local toolshed. That means safe and largely automated +installation in any production Galaxy configured to use your toolshed. + +**Generated tool Security** + +Once you install a generated tool, it's just +another tool - assuming the script is safe. They just run normally and their +user cannot do anything unusually insecure but please, practice safe toolshed. +Read the code before you install any tool. Especially this one - it is really scary. + +**Send Code** + +Patches and suggestions welcome as bitbucket issues please? + +**Attribution** + +Creating re-usable tools from scripts: The Galaxy Tool Factory +Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team +Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573 + +http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref + +**Licensing** + +Copyright Ross Lazarus 2010 +ross lazarus at g mail period com + +All rights reserved. + +Licensed under the LGPL + +**Obligatory screenshot** + +http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/test-data/output2_sample Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,165 @@ +*trats uoy erofeb GNINRAW* + +YLNO yxalaG etavirp a no loot siht llatsnI +ecnatsni noitcudorp ro cilbup a no REVEN esaelP + +troppus noitatic gnidda notlihC nhoJ yb 4102 tsugua detadpU + +keeB ned nav suiraM yb detroper sgub xif ot 4102 8 tsugua detadpU + +ta ecruoser eht etic esaelP +fer=epytyek&JWYdwMrWs1hQzcl=yekji?375stb/tnirper/igc/gro.slanruojdrofxo.scitamrofnioib//:ptth +.krow dehsilbup ruoy ni loot siht esu uoy fi + +**yrotS trohS** + +.sloot yxalaG wen gnitareneg fo elbapac loot yxalaG lausunu na si sihT +gnitpircs suoregnad ylemertxe erofereht dna *detcirtsernu* gnisopxe yb skrow tI +ot meht gniwolla ,revres yxalaG tsoh eht fo srotartsinimda detangised lla ot +,stes atad tupni detceles elpitlum revo lrep dna hs ,nohtyp ,R ni stpircs nur +.tuptuo sa tes atad wen elgnis a gnitirw + +*sretemarap elyts esrapgra ro lanoitisop htiw elbatucexe yna ro tpircs hsab/lrep/nohtyp/r gnikrow a evah uoY* + +.loot yxalaG a gnisu ,setunim ni loot yxalaG yranidro na otni denrut eb nac tI + + +**yxalaG yna otni noitallatsni rof sloot yxalaG wen fo noitareneg detamotuA** + +.ylppus uoy sgnittes retemarap dna stupni atad tset elpmas llams gnisu detareneg si tset A +a dliub ot desu eb nac yeht ,decudorp neeb evah stuptuo esac tset eht ecnO +tnemeriuqer a sa dekab si elbatucexe ro tpircs deilppus ehT .loot yxalaG wen +.xob eht fo tuo elbitapmoc wolfkrow ylluf ,loot yxalaG yranidro ,wen a otni +rotartsinimda na yb dehs loot a aiv dellatsni era sloot detareneG +.sresu ruoy rof sloot yxalaG rehto lla ekil yltcaxe krow dna + +**liateD eroM** + +a otni etsap ot tpircs a deraperp evah dluohs uoy ,yrotcaFlooT eht esu oT +yrotsih ruoy morf tceles ot ydaer elpmaxe tupni tset llams a dna dnim ni egakcap a evah ro ,xob txet +.tpircs wen ruoy tset ot + +em rof skrow ```atad-tset/yrotcafloot/srekam_loot/sloot/yxalag/~ atad_tset-- yxalag/~ toor_yxalag-- lmx.2yrotcaFlooTgr tset omenalp``` + +uoY .mrof yrotcaF looT eht no egaugnal gnitpircs hcae ni elpmaxe na si erehT +thgir eht tceles ot rebmemer - tuo ti yrt ot eseht etsap dna tuc tsuj nac +gnisu tes atad tset llams a etaerc ot deen osla ll'uoY .esaelp reterpretni +.loot atad wen dda yrotsih yxalaG eht + +ni tuptuo loot eht no nottub "oder" eht esu ,wohemos sliaf tpircs eht fI +gub eht xiF .tpircs nekorb htiw etelpmoc mrof eht etaercer ot yrotsih ruoy +.taeper ,hsaw ,esniR .niaga etucexe dna + +tpircs ruoy snur taht loot yxalaG wen a ,yllufssecus snur tpircs eht ecnO +dna txet pleh emos ylppus dna noitpo "etareneg" eht tceleS .detareneg eb nac +epytatad yxalaG wen a fo mrof eht ni detareneg eb lliw loot wen ehT .seman +a ot daolpu ot ydaer evihcra na s'ti ,stseggus eman eht sa - *zg.dehsloot* +.yrotisoper loot wen a sa dehSlooT yxalaG + +revres yxalaG lacol yna otni dellatsni eb nac ti ,dehSlooT a ni s'ti ecnO +.ecafretni evitartsinimda revres eht morf + +tpircs eht ,emit hcae - ti nur nac sresu lacol ,dellatsni si loot wen eht ecnO +nesohc tupni eht htiw detucexe eb lliw tliub saw ti nehw deilppus saw taht +eht htiw etareneg uoy sloot eht ,sdrow rehto nI .yrotsih s'resu eht morf +.emit yreve tpircs ruoy nur tub,loot yxalaG rehto yna ekil tsuj nur yrotcaFlooT + +,tuptuo eno ,tupni enO .stnenopmoc wolfkrow rof tcefrep era sloot yrotcaf looT +.selbairav on + +,loot siht fo *rewop emosewa eht tiolpxe ylefas dna ylluf oT* +siht gnillatsni repoleved a eb dluohs uoy ,dehSlooT eht dna yxalaG +na era uoy erehw ecnatsni lacol hctarcs/lanosrep/etavirp a no loot +ees seceip eht lla peek ot teg uoy ,ti kaerb uoy fi ,nehT .resu_nimda +emoH/ikiw/yrotcaflootyxalag/rabuf/gro.tekcubtib//:sptth + +**noitallatsnI** +eht gnisu yltneinevnoc tsom ti llatsni nac uoY .loot yxalaG a si sihT +niaM yxalaG eht dniF .knil "sdehs loot esworb dna hcraeS" evitartsinimda +yrotcafloot eht rof hcraes dna /ude.usp.xb.2g.dehsloot//:sptth ta dehsloot +.ti llatsni ot noitpo eht tceles dna edoc eht weiver dna ti nepO .yrotisoper + +eb ot deen ereh selif yp dna lmx eht ,yaw taht loot eht teg t'nac uoy fI +sloot wen a otni deipoc +yrtne wen a sdeen lmx.fnoc_loot ruoY yrotcafloot/sloot sa hcus yrotceridbus +lmx eht ot gnitniop +::ekil gnihtemos - elif + +>"sredliubloot"=di "sloot gnidliub looT"=eman noitces< +>/"lmx.yrotcaFlooTgr/yrotcafloot"=elif loot< +>noitces/< + +,ereht ydaerla ton fI +:dda esaelp +"yraniB:yranib.sepytatad.yxalag"=epyt "zg.dehsloot"=noisnetxe epytatad< +>/ "eurT"=ssalcbus "pizg-x/trapitlum"=epytemim +.lmx.fnoc_sepyt_atad lacol ruoy ot + + +**noitucexe detcirtseR** + +- sresu nimda yb YLNO elbasu eb neht lliw flesti loot yrotcaf loot ehT +YLNO .thgir s'taht ,seY** ini.igsw_esrevinu ni sresu_nimda ni sDI htiw elpoep +ot dewolla fI .tnemom a rof ti tuoba knihT **loot siht nur nac sresu_nimda +dluow taht gniht ylno eht ,revres yxalaG ruoy no tpircs yrartibra yna nur +ylbaborp dluow atad yxalaG ruoy lla gniyortsed no tneb tnaercsim a edepmi +.slliks lacinhcet etairporppa fo kcal eb + +**seod ti tahW** + +dna R ,nohtyp ni stpircs elpmis rof yrotcaf loot a si sihT +.taht si looc woH .detareneg yllacitamotua era stset lanoitcnuF .yltnerruc lrep + +nac yllanoitpO .yrotsih eht morf tupni eno daer taht stpircs elpmis ot DETIMIL +stuptuo fo rebmun yna tcelloc yllanoitpo dna ,tesatad yrotsih wen eno etirw +- etagivan ot resu eht rof egap xedni LMTH detarenegotua na no sknil otni +nwohs era stuptuo fdp - selif tuptuo dna segami setirw tpircs eht fi lufesu +dna taht os tpircstsohg htiw knurhs era s'fdp detaolb s'R dna slianbmuht sa +.elbaliava eb ot deen kigamegami + +trats os ,loot yxalaG yna ekil decnahne dna detide eb nac sloot detareneG +a ot pu gel suoires a uoy steg tpircs detareneg a ecnis pu dliub dna llams +.eno xelpmoc erom + +**od uoy tahW** + +dna srorre xatnys eht xif uoy ,tpircs ruoy nur dna etsap uoY +erofeb tpircs eht tide dna nottub oder eht esu nac uoY .snur ti yllautneve +.llew ytterp skrow ti - gubed uoy sa ti nurer ot gniyrt + +elbitapmoc dehsloot a etareneg nac uoy ,atad tset emos no skrow tpircs eht ecnO +ni loot yxalaG yranidro na sa nur ot ydaer tpircs ruoy gniniatnoc elif pizg +detamotua ylegral dna efas snaem tahT .dehsloot lacol ruoy no yrotisoper a +.dehsloot ruoy esu ot derugifnoc yxalaG noitcudorp yna ni noitallatsni + +**ytiruceS loot detareneG** + +tsuj s'ti ,loot detareneg a llatsni uoy ecnO +rieht dna yllamron nur tsuj yehT .efas si tpircs eht gnimussa - loot rehtona +.dehsloot efas ecitcarp ,esaelp tub erucesni yllausunu gnihtyna od tonnac resu +.yracs yllaer si ti - eno siht yllaicepsE .loot yna llatsni uoy erofeb edoc eht daeR + +**edoC dneS** + +?esaelp seussi tekcubtib sa emoclew snoitseggus dna sehctaP + +**noitubirttA** + +yrotcaF looT yxalaG ehT :stpircs morf sloot elbasu-er gnitaerC +maeT yxalaG ehT ;nnameiZ kraM ;ipsaK ynotnA ;surazaL ssoR +375stb/scitamrofnioib/3901.01 :iod ;2102 scitamrofnioiB + +fer=epytyek&JWYdwMrWs1hQzcl=yekji?375stb/tnirper/igc/gro.slanruojdrofxo.scitamrofnioib//:ptth + +**gnisneciL** + +0102 surazaL ssoR thgirypoC +moc doirep liam g ta surazal ssor + +.devreser sthgir llA + +LPGL eht rednu desneciL + +**tohsneercs yrotagilbO** + +gnp.looTtpircScimanyd/segami/989ef2308adf/crs/rekamlootyxalag/rabuf/gro.tekcubtib//:ptth
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/test-data/pyrevpos.python Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,13 @@ +# reverse order of text by row +import sys +inp = sys.argv[1] +outp = sys.argv[2] +i = open(inp,'r').readlines() +o = open(outp,'w') +for row in i: + rs = row.rstrip() + rs = list(rs) + rs.reverse() + o.write(''.join(rs)) +o.close() +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolfactory_docker/test-data/test1_log.txt Tue Jan 05 00:35:40 2021 +0000 @@ -0,0 +1,1 @@ +## Executing Toolfactory generated command line = python /tmp/pyrevposq5dmcdy1.python /tmp/tmpqrksf8sd/files/5/b/9/dataset_5b952a86-87df-44ad-a415-ea549f3f0cee.dat output2