2 | The AppGallery Connect API secret key. See the documentation here on how to get this key.
3 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # AppGallery Jenkins plugin
2 |
3 | ## Introduction
4 | Jenkins Plugin to support uploading your Android Application to AppGallery
5 |
6 | This makes use of the [AppGallery Connect API](https://developer.huawei.com/consumer/en/doc/development/AppGallery-connect-Guides/agcapi-overview-0000001158245083) to upload your build android application to AppGallery.
7 |
8 | Note that you will need to have already build the APK or AAB file before using this plugin
9 |
10 | ## Resources
11 |
12 | [AppGallery Connect](https://developer.huawei.com/consumer/en/agconnect/) - Learn more about AppGallery Connect Services, and signup for a developer account!
13 |
14 | ### How to Contribute
15 |
16 | We welcome [issues](https://github.com/devwithzachary/appgallery-plugin/issues) to and [pull requests](https://github.com/devwithzachary/appgallery-plugin/pulls) against this repository!
17 |
--------------------------------------------------------------------------------
/src/main/resources/com/huawei/jenkins/AppGalleryUploadBuilder/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
20 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/main/resources/META-INF/hudson.remoting.ClassFilter:
--------------------------------------------------------------------------------
1 | okhttp3.*
2 | okhttp3.MediaType
3 | okhttp3.MultipartBody
4 | okhttp3.OkHttpClient
5 | okhttp3.Request
6 | okhttp3.RequestBody
7 | okhttp3.Response
8 | okhttp3.Dispatcher
9 | okhttp3.ConnectionPool
10 | okhttp3.internal.*
11 | okhttp3.internal.connection.RealConnectionPool
12 | okhttp3.internal.concurrent.TaskQueue
13 | okhttp3.internal.concurrent.TaskRunner
14 | okhttp3.internal.concurrent.TaskRunner$runnable$1
15 | okhttp3.internal.concurrent.TaskRunner$runnable
16 | okhttp3.internal.concurrent.TaskRunner$RealBackend
17 | java.util.*
18 | java.util.concurrent.*
19 | java.util.concurrent.ThreadPoolExecutor
20 | java.util.concurrent.atomic.AtomicInteger
21 | java.util.concurrent.SynchronousQueue
22 | java.util.concurrent.locks.ReentrantLock
23 | java.util.concurrent.locks.ReentrantLock$NonfairSync
24 | java.util.concurrent.SynchronousQueue$LifoWaitQueue
25 | java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject
26 | okhttp3.internal.Util$threadFactory$1
27 | java.util.concurrent.ThreadPoolExecutor$AbortPolicy
28 | okhttp3.internal.connection.RealConnectionPool$cleanupTask$1
29 | okhttp3.internal.Util$asFactory$1
30 | okhttp3.EventListener$Companion$NONE$1
31 | okhttp3.Authenticator$Companion$AuthenticatorNone
32 | okhttp3.CookieJar$Companion$NoCookies
33 | okhttp3.Dns$Companion$DnsSystem
34 | sun.net.spi.DefaultProxySelector
35 | javax.net.DefaultSocketFactory
36 | sun.security.ssl.SSLSocketFactoryImpl
37 | sun.security.ssl.SSLContextImpl$TLSContext
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 4.0.0
4 |
5 | org.jenkins-ci.plugins
6 | plugin
7 | 4.32
8 |
9 |
10 | com.huawei.jenkins
11 | agc-app-upload
12 | ${revision}${changelist}
13 | hpi
14 | AppGallery Connect App Upload
15 | https://github.com/jenkinsci/${project.artifactId}-plugin
16 |
17 |
18 | MIT License
19 | https://opensource.org/licenses/MIT
20 |
21 |
22 |
23 | scm:git:https://github.com/${gitHubRepo}
24 | scm:git:https://github.com/${gitHubRepo}
25 | ${scmTag}
26 | https://github.com/${gitHubRepo}
27 |
28 |
29 | 1.0
30 | -SNAPSHOT
31 | 2.277.2
32 | 8
33 | AppGalleryConnect/agc-jenkins-plugin
34 |
35 |
36 |
37 |
38 |
39 |
40 | io.jenkins.tools.bom
41 | bom-2.277.x
42 | 961.vf0c9f6f59827
43 | pom
44 | import
45 |
46 |
47 |
48 |
49 |
50 | org.jenkins-ci.plugins
51 | structs
52 |
53 |
54 | org.jenkins-ci.plugins.workflow
55 | workflow-cps
56 | test
57 |
58 |
59 | org.jenkins-ci.plugins.workflow
60 | workflow-job
61 | test
62 |
63 |
64 | org.jenkins-ci.plugins.workflow
65 | workflow-basic-steps
66 | test
67 |
68 |
69 | org.jenkins-ci.plugins.workflow
70 | workflow-durable-task-step
71 | test
72 |
73 |
74 | io.jenkins.plugins
75 | okhttp-api
76 | 4.9.3-105.vb96869f8ac3a
77 |
78 |
79 |
84 |
85 | org.json
86 | json
87 | 20211205
88 |
89 |
90 |
91 |
92 |
93 | repo.jenkins-ci.org
94 | https://repo.jenkins-ci.org/public/
95 |
96 |
97 |
98 |
99 | repo.jenkins-ci.org
100 | https://repo.jenkins-ci.org/public/
101 |
102 |
103 |
104 |
--------------------------------------------------------------------------------
/src/main/java/com/huawei/jenkins/AppGalleryUploadBuilder.java:
--------------------------------------------------------------------------------
1 | package com.huawei.jenkins;
2 |
3 | import hudson.EnvVars;
4 | import hudson.Extension;
5 | import hudson.FilePath;
6 | import hudson.Launcher;
7 | import hudson.model.AbstractProject;
8 | import hudson.model.Run;
9 | import hudson.model.TaskListener;
10 | import hudson.remoting.ClassFilter;
11 | import hudson.tasks.BuildStepDescriptor;
12 | import hudson.tasks.Builder;
13 | import hudson.util.FormValidation;
14 | import hudson.util.Secret;
15 | import jenkins.tasks.SimpleBuildStep;
16 | import okhttp3.*;
17 | import org.jenkinsci.Symbol;
18 | import org.json.JSONObject;
19 | import org.kohsuke.stapler.DataBoundConstructor;
20 | import org.kohsuke.stapler.QueryParameter;
21 |
22 | import javax.servlet.ServletException;
23 | import java.io.IOException;
24 | import java.text.MessageFormat;
25 |
26 | public class AppGalleryUploadBuilder extends Builder implements SimpleBuildStep {
27 |
28 | public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");
29 | OkHttpClient client = new OkHttpClient();
30 |
31 | private final String path, clientId, appId, suffix;
32 | private final Secret secret;
33 | private transient FilePath workspaceFilePath;
34 |
35 | public String getPath() {
36 | return path;
37 | }
38 |
39 | public FilePath getWorkspacePath() {
40 | return workspaceFilePath;
41 | }
42 |
43 | public Secret getSecret() {
44 | return secret;
45 | }
46 |
47 | public String getClientId() {
48 | return clientId;
49 | }
50 |
51 | public String getAppId() {
52 | return appId;
53 | }
54 |
55 | public String getSuffix() {
56 | return suffix;
57 | }
58 |
59 | @DataBoundConstructor
60 | public AppGalleryUploadBuilder(String path, Secret secret, String clientId, String appId, String suffix) {
61 | this.path = path;
62 | this.secret = secret;
63 | this.clientId = clientId;
64 | this.appId = appId;
65 | this.suffix = suffix;
66 | ClassFilter.setDefault(ClassFilter.NONE);
67 | }
68 |
69 | @Override
70 | public void perform(Run run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener) throws InterruptedException, IOException {
71 |
72 | listener.getLogger().println("Starting Upload");
73 | workspaceFilePath = workspace.child(getPath());
74 | String accessToken = getAccessToken();
75 | listener.getLogger().println("Got Access Token");
76 |
77 | JSONObject uploadDetails = getUploadDetails(accessToken);
78 | listener.getLogger().println("Got Upload Details");
79 | String uploadUrl = uploadDetails.getString("uploadUrl");
80 | String uploadAuthCode = uploadDetails.getString("authCode");
81 |
82 | listener.getLogger().println(MessageFormat.format("UploadUrl: {0}", uploadUrl));
83 | String fileURL = uploadFile(uploadUrl, accessToken, uploadAuthCode, listener);
84 |
85 | attachFileToApp(accessToken, fileURL);
86 | submitApp(accessToken);
87 |
88 | listener.getLogger().println("Uploaded");
89 |
90 | }
91 |
92 | @Symbol("greet")
93 | @Extension
94 | public static final class DescriptorImpl extends BuildStepDescriptor {
95 |
96 | public FormValidation doCheckName(@QueryParameter String value, @QueryParameter boolean useFrench)
97 | throws IOException, ServletException {
98 |
99 | return FormValidation.ok();
100 | }
101 |
102 | @Override
103 | public boolean isApplicable(Class aClass) {
104 | return true;
105 | }
106 |
107 | @Override
108 | public String getDisplayName() {
109 | return "Upload Application to AppGallery";
110 | }
111 |
112 | }
113 |
114 | JSONObject getUploadDetails(String authCode) throws IOException {
115 | return get("https://connect-api.cloud.huawei.com/api/publish/v2/upload-url?appId=" + getAppId() + "&suffix=" + getSuffix(), authCode);
116 | }
117 |
118 | void submitApp(String authHeader) throws IOException {
119 | post("https://connect-api.cloud.huawei.com/api/publish/v2/app-submit?appId=" + getAppId(), "", authHeader);
120 | }
121 |
122 | String getAccessToken() throws IOException {
123 | JSONObject authJson = new JSONObject();
124 | authJson.put("client_id", getClientId());
125 | authJson.put("client_secret", getSecret().getPlainText());
126 | authJson.put("grant_type", "client_credentials");
127 |
128 | String jsonString = authJson.toString();
129 | JSONObject authResponse = post("https://connect-api.cloud.huawei.com/api/oauth2/v1/token", jsonString, null);
130 |
131 | return authResponse.getString("access_token");
132 | }
133 |
134 | void attachFileToApp(String authHeader, String fileURL) throws IOException {
135 | JSONObject files = new JSONObject();
136 | files.put("fileName", "app.apk");
137 | files.put("fileDestUrl", fileURL);
138 |
139 | JSONObject authJson = new JSONObject();
140 | authJson.put("fileType", "5");
141 | authJson.put("files", files);
142 |
143 | String jsonString = authJson.toString();
144 | put("https://connect-api.cloud.huawei.com/api/publish/v2/app-file-info?appId=" + getAppId(), jsonString, authHeader);
145 | }
146 |
147 | JSONObject post(String url, String json, String authHeader) throws IOException {
148 | RequestBody body = RequestBody.create(JSON, json);
149 | Request.Builder requestBuilder = new Request.Builder()
150 | .url(url)
151 | .addHeader("client_id", getClientId())
152 | .post(body);
153 | if (authHeader != null) {
154 | requestBuilder.addHeader("Authorization", "Bearer " + authHeader);
155 | }
156 | Request request = requestBuilder.build();
157 | try (Response response = client.newCall(request).execute()) {
158 | return new JSONObject(response.body().string());
159 | }
160 | }
161 |
162 | JSONObject get(String url, String authHeader) throws IOException {
163 | Request.Builder requestBuilder = new Request.Builder()
164 | .addHeader("client_id", getClientId())
165 | .url(url);
166 | if (authHeader != null) {
167 | requestBuilder.addHeader("Authorization", "Bearer " + authHeader);
168 | }
169 | Request request = requestBuilder.build();
170 | try (Response response = client.newCall(request).execute()) {
171 | return new JSONObject(response.body().string());
172 | }
173 | }
174 |
175 | JSONObject put(String url, String json, String authHeader) throws IOException {
176 | RequestBody body = RequestBody.create(JSON, json);
177 | Request.Builder requestBuilder = new Request.Builder()
178 | .url(url)
179 | .addHeader("client_id", getClientId())
180 | .put(body);
181 | if (authHeader != null) {
182 | requestBuilder.addHeader("Authorization", "Bearer " + authHeader);
183 | }
184 | Request request = requestBuilder.build();
185 | try (Response response = client.newCall(request).execute()) {
186 | return new JSONObject(response.body().string());
187 | }
188 | }
189 |
190 | String uploadFile(String url, String authHeader, String fileAuthCode, TaskListener listener) throws IOException, InterruptedException {
191 |
192 | listener.getLogger().println("Application File: " + getWorkspacePath().toString());
193 | if (!getWorkspacePath().exists()) {
194 | throw new IOException(getWorkspacePath().toString() + ": File does not exist!");
195 | }
196 | MediaType mediaType = MediaType.parse("application/vnd.android.package-archive");
197 | RequestBody requestFileBody = RequestBody.create(mediaType, getWorkspacePath().read().toString().getBytes());
198 |
199 | RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
200 | .addFormDataPart("file", "upload.apk", requestFileBody)
201 | .addFormDataPart("authCode", fileAuthCode)
202 | .addFormDataPart("fileCount", "1")
203 | .build();
204 |
205 | Request.Builder requestBuilder = new Request.Builder()
206 | .url(url)
207 | .addHeader("client_id", getClientId())
208 | .post(body);
209 |
210 | OkHttpClient client = new OkHttpClient().newBuilder()
211 | .build();
212 | Request request = requestBuilder.build();
213 |
214 | try (Response response = client.newCall(request).execute()) {
215 | JSONObject responseJSON = new JSONObject(response.body().string());
216 | listener.getLogger().println("Got file upload response");
217 |
218 | return responseJSON.getJSONObject("result").getJSONObject("UploadFileRsp").getJSONArray("fileInfoList").getJSONObject(0).getString("fileDestUlr");
219 |
220 | }
221 | }
222 | }
223 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------