├── LICENSE ├── README.md ├── testfairy-uploader.sh └── upload-dsym.sh /LICENSE: -------------------------------------------------------------------------------- 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 2014 TestFairy 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. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | TestFairy Command Line Uploader 2 | =============================== 3 | 4 | TestFairy's Command Line Uploader is a shell script to upload your IPA or APK files to TestFairy for monitoring and distribution. 5 | 6 | There are 3 shell scripts in this repository: 7 | 8 | * `testfairy-uploader.sh` 9 | Will upload iOS IPA files or Android APK files to TestFairy for distribution. 10 | 11 | * `testfairy-upload-android-windows.bat` 12 | Will upload APK Files from Windows servers. 13 | 14 | When working with these shells scripts, notice that you will have to edit them and provide your **API KEY** and (optionally) other values such as testers groups to invite, metrics to record and other settings. 15 | 16 | Support 17 | ======= 18 | 19 | For support, please look here https://docs.testfairy.com/API/Upload_API.html 20 | For questions not covered there, please contact support via the developer dashboard or at our [email address](mailto:support@testfairy.com) 21 | 22 | License 23 | ======= 24 | 25 | Released under Apache License. 26 | -------------------------------------------------------------------------------- /testfairy-uploader.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # This upload script is both for iOS and Android. 4 | 5 | UPLOADER_VERSION=2.14 6 | # Put your TestFairy API_KEY here. Find it here: https://app.testfairy.com/settings/#tab-api-key 7 | # This is a mandatory parameter. 8 | TESTFAIRY_API_KEY= 9 | 10 | # Tester Groups that will be allows to download the app and will be notified in case NOTIFY equals "on". 11 | # create those groups in https://app.testfairy.com/testers/ 12 | # In case of more than one group seperate by comma. Example "family,friends" 13 | # This param is required in case NOTIFY is on. 14 | GROUPS= 15 | 16 | # Should email testers about new version. Set to "off" to disable email notifications. 17 | NOTIFY="off" 18 | 19 | # If AUTO_UPDATE is "on" users of older versions will be prompt to update to this build next time they run the app 20 | AUTO_UPDATE="off" 21 | 22 | # Use comment field to add release notes. Text will be included in the email sent to testers and in landing pages. 23 | COMMENT="" 24 | 25 | # locations of various tools 26 | CURL=curl 27 | 28 | SERVER_ENDPOINT=https://upload.testfairy.com 29 | 30 | usage() { 31 | echo "Usage: testfairy-upload-ios.sh APP_FILENAME" 32 | echo 33 | } 34 | 35 | verify_tools() { 36 | 37 | # Windows users: this script requires curl. If not installed please get from http://cygwin.com/ 38 | 39 | # Check 'curl' tool 40 | "${CURL}" --help >/dev/null 41 | if [ $? -ne 0 ]; then 42 | echo "Could not run curl tool, please check settings" 43 | exit 1 44 | fi 45 | } 46 | 47 | verify_settings() { 48 | if [ -z "${TESTFAIRY_API_KEY}" ]; then 49 | usage 50 | echo "Please update API_KEY with your private API key, as noted in the Settings page" 51 | exit 1 52 | fi 53 | } 54 | 55 | if [ $# -ne 1 ]; then 56 | usage 57 | exit 1 58 | fi 59 | 60 | # before even going on, make sure all tools work 61 | verify_tools 62 | verify_settings 63 | 64 | APP_FILENAME=$1 65 | if [ ! -f "${APP_FILENAME}" ]; then 66 | usage 67 | echo "Can't find file: ${APP_FILENAME}" 68 | exit 2 69 | fi 70 | 71 | # temporary file paths 72 | DATE=`date` 73 | 74 | /bin/echo -n "Uploading ${APP_FILENAME} to TestFairy.. " 75 | JSON=$( "${CURL}" -s ${SERVER_ENDPOINT}/api/upload -F api_key=${TESTFAIRY_API_KEY} -F file="@${APP_FILENAME}" -F comment="${COMMENT}" -F groups="${GROUPS}" -F auto-update="${AUTO_UPDATE}" -F notify="${NOTIFY}" -A "TestFairy Command Line Uploader ${UPLOADER_VERSION}" ) 76 | 77 | URL=$( echo ${JSON} | sed 's/\\\//\//g' | sed -n 's/.*"build_url"\s*:\s*"\([^"]*\)".*/\1/p' ) 78 | if [ -z "$URL" ]; then 79 | echo "FAILED!" 80 | echo 81 | echo "Build uploaded, but no reply from server. Please contact support@testfairy.com" 82 | exit 1 83 | fi 84 | 85 | echo "OK!" 86 | echo 87 | echo "Build was successfully uploaded to TestFairy and is available at:" 88 | echo ${URL} 89 | -------------------------------------------------------------------------------- /upload-dsym.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | TESTFAIRY_ENDPOINT="https://app.testfairy.com/upload/dsym/" 4 | 5 | ZIP=zip 6 | CURL=curl 7 | STAT=stat 8 | DATE=date 9 | 10 | log() { 11 | NOW=$($DATE +"%Y-%m-%d %H:%M:%S") 12 | echo "${NOW} ${1}" 13 | } 14 | 15 | help() { 16 | echo "Usage: ${0} [-f] TESTFAIRY_API_KEY [-p DSYM_PATH] [-u TESTFAIRY_ENDPOINT]" 17 | exit 1 18 | } 19 | 20 | DAEMON=1 21 | if [ "${1}" == "-f" ]; then 22 | DAEMON=0 23 | shift 24 | elif [ "${1}" == "-d" ]; then 25 | # backward compatible when -f was the default 26 | shift 27 | fi 28 | 29 | 30 | API_KEY="${1}" 31 | if [ ! "${API_KEY}" ]; then 32 | echo "Fatal: No Upload API key provided." 33 | help 34 | fi 35 | 36 | DSYM_PATH=${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME} 37 | 38 | shift 39 | while [[ $# -gt 1 ]] 40 | do 41 | key="$1" 42 | case $key in 43 | -u) 44 | TESTFAIRY_ENDPOINT="${2}" 45 | shift 46 | ;; 47 | -p) 48 | DSYM_PATH="${2}" 49 | shift 50 | ;; 51 | *) 52 | help 53 | ;; 54 | esac 55 | shift 56 | done 57 | 58 | if [ "${DSYM_PATH}" == "" ] || [ "${DSYM_PATH}" == "/" ] || [ ! -d "${DSYM_PATH}" ]; then 59 | echo "Fatal: No .dSYM folder found at path [${DSYM_PATH}]." 60 | help 61 | fi 62 | 63 | if [[ ${TESTFAIRY_ENDPOINT} == "" ]]; then 64 | echo "Fatal: No upload endpoint given." 65 | help 66 | fi 67 | 68 | NOW=$($DATE +%s) 69 | TMP_FILENAME="/tmp/${NOW}-${DWARF_DSYM_FILE_NAME}.zip" 70 | 71 | # Compress the .dSYM folder into a zip file 72 | log "Compressing .dSYM folder ${DSYM_PATH}" 73 | $ZIP -qrp9 "${TMP_FILENAME}" "${DSYM_PATH}" 74 | FILE_SIZE=$($STAT -f "%z" "${TMP_FILENAME}") 75 | 76 | foreground_upload() { 77 | # Upload zipped .dSYM file to TestFairy's servers 78 | STARTED=$($DATE +"%s") 79 | $CURL -s -F api_key="${API_KEY}" -F dsym=@"${1}" -o /dev/null "${TESTFAIRY_ENDPOINT}" 80 | ENDED=$($DATE +"%s") 81 | DIFF=$(expr ${ENDED} - ${STARTED}) 82 | log "Symbols uploaded in ${DIFF} seconds" 83 | 84 | # Clean up behind 85 | rm -f ${TMP_FILENAME} 86 | } 87 | 88 | background_upload() { 89 | sh -c "$CURL -F api_key=\"${API_KEY}\" -F dsym=@\"${1}\" -s -o /dev/null \"${TESTFAIRY_ENDPOINT}\"; rm -f ${TMP_FILENAME};" /dev/null 2>&1 & 90 | } 91 | 92 | if [ "$DAEMON" == "0" ]; then 93 | log "Uploading ${FILE_SIZE} bytes to dsym server in foreground" 94 | foreground_upload "${TMP_FILENAME}" 95 | else 96 | log "Uploading ${FILE_SIZE} bytes to dsym server in background" 97 | background_upload "${TMP_FILENAME}" 98 | fi 99 | 100 | log "TestFairy .dSYM upload script ends" 101 | 102 | --------------------------------------------------------------------------------