├── .gitignore ├── README.md ├── lib └── build_execution.rb └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | Gemfile.lock 2 | *.gem 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # build_execution gem 2 | Execution primitives that force explicit error handling and never call the shell. 3 | 4 | ## How to use 5 | The interface is similar to Open3.capture2e. We print the command to stdout before running it (unless `:quiet=> true`). By default the command process shares the calling process's stdout, but this can be changed. Options passed to fail_on_error are passed through to popen2e. 6 | 7 | ``` 8 | > require 'build_execution' 9 | > fail_on_error('/bin/echo', '-n', 'asdf') 10 | Running Command: 11 | "/bin/echo" "-n" "asdf" 12 | asdf => "asdf" 13 | > fail_on_error('/bin/echo', '-n', 'asdf', :quiet=>true) 14 | => "asdf" 15 | > 16 | ``` 17 | 18 | `fail_pipe_on_error` has a similar interface, but it takes lists of commands similar to Open3.pipeline. Any additional options are passed to Open3.pipeline_r under the hood. 19 | 20 | 21 | -------------------------------------------------------------------------------- /lib/build_execution.rb: -------------------------------------------------------------------------------- 1 | # Copyright 2014 Square Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | require 'open3' 16 | 17 | # Wrapper around open3.pipeline_r which fails on error. 18 | # and stops users from invoking the shell by accident. 19 | # 20 | def fail_pipe_on_error (*cmd_list, quiet: false, **opts) 21 | puts "Running Pipeline: \n#{debug_print_cmd_list(cmd_list)}\n" unless quiet 22 | 23 | cmd_list.each{ |cmd| shell_safe(cmd) } 24 | 25 | output, *status_list = Open3.pipeline_r(*cmd_list, opts) { |out, wait_threads| 26 | out_reader = Thread.new { 27 | if quiet 28 | output = out.read() 29 | else 30 | # Output from pipeline should go to stdout and also get returned for processing if necessary. 31 | output = tee(out, STDOUT) 32 | end 33 | out.close 34 | output 35 | } 36 | [out_reader.value] + wait_threads.map { |t| t.value } 37 | } 38 | exit_on_status(output, cmd_list, status_list, quiet: quiet) 39 | end 40 | 41 | # Wrapper around open3.popen2e which fails on error 42 | # 43 | # We emulate open3.capture2e with the following changes in behavior: 44 | # 1) The command is printed to stdout before execution. 45 | # 2) Attempts to use the shell implicitly are blocked. 46 | # 3) Nonzero return codes result in the process exiting. 47 | # 4) Combined stdout/stderr goes to callers stdout (continuously streamed) and is returned as a string 48 | # 49 | # If you're looking for more process/stream control read the spawn documentation, and pass 50 | # options directly here 51 | def fail_on_error (*cmd, stdin_data: nil, binmode: false, quiet: false, **opts) 52 | puts "Running Command: \n#{debug_print_cmd_list([cmd])}\n" unless quiet 53 | cmd = shell_safe(cmd) 54 | 55 | # Most of this is copied from Open3.capture2e in ruby/lib/open3.rb 56 | output, status = Open3.popen2e(*cmd, opts) { |i, oe, t| 57 | if binmode 58 | i.binmode 59 | oe.binmode 60 | end 61 | outerr_reader = Thread.new { 62 | if quiet 63 | oe.read 64 | else 65 | # Instead of oe.read, we redirect. 66 | # Output from command goes to stdout and also is returned for processing if necessary 67 | tee(oe, STDOUT) 68 | end 69 | } 70 | if stdin_data 71 | begin 72 | i.write stdin_data 73 | rescue Errno::EPIPE 74 | end 75 | end 76 | i.close 77 | [outerr_reader.value, t.value] 78 | } 79 | exit_on_status(output, [cmd], [status], quiet: quiet) 80 | end 81 | 82 | # Look at a cmd list intended for spawn. 83 | # determine if spawn will call the shell implicitly, fail in that case. 84 | def shell_safe (cmd) 85 | # Take the first string and change it to a list of [executable,argv0] 86 | # This syntax for calling popen2e (and eventually spawn) avoids 87 | # the shell in all cases 88 | if cmd[0].class == String 89 | cmd[0] = [ cmd[0], cmd[0] ] 90 | end 91 | cmd 92 | end 93 | 94 | def debug_print_cmd_list(cmd_list) 95 | # Take a list of command argument lists like you'd sent to open3.pipeline or fail_on_error_pipe and 96 | # print out a string that would do the same thing when entered at the shell. 97 | # 98 | # This is a converter from our internal representation of commands to a subset of bash that 99 | # can be executed directly. 100 | # 101 | # Note this has problems if you specify env or opts 102 | # TODO: make this remove those command parts 103 | "\"" + 104 | cmd_list.map { |cmd| 105 | cmd.map { |arg| 106 | arg.gsub("\"", "\\\"") # Escape all double quotes in command arguments 107 | }.join("\" \"") # Fully quote all command parts. We add quotes to the beginning and end too. 108 | }.join("\" | \"") + # Pipe commands to one another. 109 | "\"" 110 | end 111 | 112 | # Takes in an input stream and an output stream 113 | # Redirects data from one to the other until the input stream closes. 114 | # Returns all data that passed through on return. 115 | # 116 | def tee(in_stream, out_stream) 117 | alldata = "" 118 | while true do 119 | begin 120 | data = in_stream.read_nonblock(4096) 121 | alldata += data 122 | out_stream.write(data) 123 | out_stream.flush() 124 | rescue IO::WaitReadable 125 | IO.select([in_stream]) 126 | retry 127 | rescue IOError 128 | break 129 | end 130 | end 131 | alldata 132 | end 133 | 134 | 135 | # If any of the statuses are bad, exits with the 136 | # return code of the first one. 137 | # 138 | # Otherwise returns first argument (output) 139 | def exit_on_status (output, cmd_list, status_list, quiet: false) 140 | status_list.each_index do | index | 141 | status = status_list[index] 142 | cmd = cmd_list[index] 143 | # Do nothing for proper statuses 144 | if status.exited? && status.exitstatus == 0 145 | next 146 | end 147 | 148 | # If we exited nonzero or abnormally, print debugging info 149 | # and explode. 150 | if status.exited? 151 | puts "Process Exited normally. Exit status:#{status.exitstatus}" unless quiet 152 | else 153 | # This should only get executed if we're stopped or signaled 154 | puts "Process exited abnormally:\nProcessStatus: #{status.inspect}\nRaw POSIX Status: #{status.to_i}\n" unless quiet 155 | end 156 | 157 | raise RuntimeError, "#{status.inspect}\n#{cmd.inspect}" 158 | end 159 | 160 | # This is some output of the command which ideally we're not interested in 161 | # for the failure case 162 | output 163 | end 164 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------