#558

Committed 08 Dec 2025 02:56PM UTC coverage: 48.239% (+0.02%) from 48.215%

Build # #558

Build Type

push

github

Committed by

aalmiray

Commit Message

feat(core): warn when a name template cannot be resolved

Closes #1960

Closes #1961

Coverage Stats

299 of 573 new or added lines in 133 files covered. (52.18%)

4 existing lines in 4 files now uncovered.

26047 of 53996 relevant lines covered (48.24%)

0.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

56.0

/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/upload/S3Uploader.java

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2025 The JReleaser authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jreleaser.model.internal.upload;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.jreleaser.model.Active;
import org.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.common.Artifact;
import org.jreleaser.mustache.TemplateContext;

import java.util.LinkedHashMap;
import java.util.Map;

import static java.util.Collections.unmodifiableMap;
import static org.jreleaser.model.Constants.HIDE;
import static org.jreleaser.model.Constants.UNSET;
import static org.jreleaser.model.api.upload.S3Uploader.TYPE;
import static org.jreleaser.mustache.Templates.resolveTemplate;
import static org.jreleaser.util.StringUtils.capitalize;
import static org.jreleaser.util.StringUtils.isBlank;
import static org.jreleaser.util.StringUtils.isNotBlank;

/**
 * @author Andres Almiray
 * @since 0.8.0
 */
public final class S3Uploader extends AbstractUploader<org.jreleaser.model.api.upload.S3Uploader, S3Uploader> {
    private static final long serialVersionUID = -747298261100208723L;

    private final Map<String, String> headers = new LinkedHashMap<>();

    private String region;
    private String bucket;
    private String path;
    private String downloadUrl;
    private String endpoint;
    private String accessKeyId;
    private String secretKey;
    private String sessionToken;

    @JsonIgnore
    private final org.jreleaser.model.api.upload.S3Uploader immutable = new org.jreleaser.model.api.upload.S3Uploader() {
        private static final long serialVersionUID = -3263159021072324345L;

        @Override
        public String getRegion() {
            return region;
        }

        @Override
        public String getBucket() {
            return bucket;
        }

        @Override
        public String getAccessKeyId() {
            return accessKeyId;
        }

        @Override
        public String getSecretKey() {
            return secretKey;
        }

        @Override
        public String getSessionToken() {
            return sessionToken;
        }

        @Override
        public String getPath() {
            return path;
        }

        @Override
        public String getDownloadUrl() {
            return downloadUrl;
        }

        @Override
        public String getEndpoint() {
            return endpoint;
        }

        @Override
        public Map<String, String> getHeaders() {
            return unmodifiableMap(headers);
        }

        @Override
        public String getType() {
            return S3Uploader.this.getType();
        }

        @Override
        public String getName() {
            return S3Uploader.this.getName();
        }

        @Override
        public boolean isSnapshotSupported() {
            return S3Uploader.this.isSnapshotSupported();
        }

        @Override
        public boolean isArtifacts() {
            return S3Uploader.this.isArtifacts();
        }

        @Override
        public boolean isFiles() {
            return S3Uploader.this.isFiles();
        }

        @Override
        public boolean isSignatures() {
            return S3Uploader.this.isSignatures();
        }

        @Override
        public boolean isChecksums() {
            return S3Uploader.this.isChecksums();
        }

        @Override
        public boolean isCatalogs() {
            return S3Uploader.this.isCatalogs();
        }

        @Override
        public Active getActive() {
            return S3Uploader.this.getActive();
        }

        @Override
        public boolean isEnabled() {
            return S3Uploader.this.isEnabled();
        }

        @Override
        public Map<String, Object> asMap(boolean full) {
            return unmodifiableMap(S3Uploader.this.asMap(full));
        }

        @Override
        public String getPrefix() {
            return S3Uploader.this.prefix();
        }

        @Override
        public Map<String, Object> getExtraProperties() {
            return unmodifiableMap(S3Uploader.this.getExtraProperties());
        }

        @Override
        public Integer getConnectTimeout() {
            return S3Uploader.this.getConnectTimeout();
        }

        @Override
        public Integer getReadTimeout() {
            return S3Uploader.this.getReadTimeout();
        }
    };

    public S3Uploader() {
        super(TYPE);
    }

    @Override
    public org.jreleaser.model.api.upload.S3Uploader asImmutable() {
        return immutable;
    }

    @Override
    public void merge(S3Uploader source) {
        super.merge(source);
        this.region = merge(this.region, source.region);
        this.bucket = merge(this.bucket, source.bucket);
        this.path = merge(this.path, source.path);
        this.downloadUrl = merge(this.downloadUrl, source.downloadUrl);
        this.endpoint = merge(this.endpoint, source.endpoint);
        this.accessKeyId = merge(this.accessKeyId, source.accessKeyId);
        this.secretKey = merge(this.secretKey, source.secretKey);
        this.sessionToken = merge(this.sessionToken, source.sessionToken);
        setHeaders(merge(this.headers, source.headers));
    }

    @Override
    public String getResolvedDownloadUrl(JReleaserContext context, Artifact artifact) {
        return getResolvedDownloadUrl(context, context.fullProps(), artifact);
    }

    @Override
    public String getResolvedDownloadUrl(JReleaserContext context, TemplateContext props, Artifact artifact) {
        if (isNotBlank(getDownloadUrl())) {
            TemplateContext p = new TemplateContext(artifactProps(props, artifact));
            p.setAll(resolvedExtraProperties());
            p.set("bucket", bucket);
            p.set("region", region);
            return resolveTemplate(context.getLogger(), getDownloadUrl(), p);
        }

        if (isBlank(getEndpoint())) {
            String url = "https://{{bucket}}.s3.{{region}}.amazonaws.com/" + path;
            TemplateContext p = new TemplateContext(artifactProps(props, artifact));
            p.setAll(resolvedExtraProperties());
            p.set("bucket", bucket);
            p.set("region", region);
            return resolveTemplate(context.getLogger(), url, p);
        }

        return "";
    }

    public String getRegion() {
        return region;
    }

    public void setRegion(String region) {
        this.region = region;
    }

    public String getBucket() {
        return bucket;
    }

    public void setBucket(String bucket) {
        this.bucket = bucket;
    }

    public String getAccessKeyId() {
        return accessKeyId;
    }

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public String getSecretKey() {
        return secretKey;
    }

    public void setSecretKey(String secretKey) {
        this.secretKey = secretKey;
    }

    public String getSessionToken() {
        return sessionToken;
    }

    public void setSessionToken(String sessionToken) {
        this.sessionToken = sessionToken;
    }

    public String getPath() {
        return path;
    }

    public void setPath(String path) {
        this.path = path;
    }

    public String getDownloadUrl() {
        return downloadUrl;
    }

    public void setDownloadUrl(String downloadUrl) {
        this.downloadUrl = downloadUrl;
    }

    public String getEndpoint() {
        return endpoint;
    }

    public void setEndpoint(String endpoint) {
        this.endpoint = endpoint;
    }

    public Map<String, String> getHeaders() {
        return headers;
    }

    public void setHeaders(Map<String, String> headers) {
        this.headers.putAll(headers);
    }

    @Override
    protected void asMap(boolean full, Map<String, Object> props) {
        props.put("region", region);
        props.put("bucket", bucket);
        props.put("accessKeyId", isNotBlank(accessKeyId) ? HIDE : UNSET);
        props.put("secretKey", isNotBlank(secretKey) ? HIDE : UNSET);
        props.put("sessionToken", isNotBlank(sessionToken) ? HIDE : UNSET);
        props.put("path", path);
        props.put("downloadUrl", downloadUrl);
        props.put("endpoint", endpoint);
        props.put("headers", headers);
    }


    public String getResolvedPath(JReleaserContext context, Artifact artifact) {
        String artifactPath = path;

        String customPathKey = "s3" + capitalize(getName()) + "Path";
        if (artifact.getExtraProperties().containsKey(customPathKey)) {
            artifactPath = artifact.getExtraProperty(customPathKey);
        }

        TemplateContext p = new TemplateContext(artifactProps(context, artifact));
        p.setAll(resolvedExtraProperties());
        return resolveTemplate(context.getLogger(), artifactPath, p);
    }
}

1	/*
2	* SPDX-License-Identifier: Apache-2.0
3	*
4	* Copyright 2020-2025 The JReleaser authors.
5	*
6	* Licensed under the Apache License, Version 2.0 (the "License");
7	* you may not use this file except in compliance with the License.
8	* You may obtain a copy of the License at
9	*
10	* https://www.apache.org/licenses/LICENSE-2.0
11	*
12	* Unless required by applicable law or agreed to in writing, software
13	* distributed under the License is distributed on an "AS IS" BASIS,
14	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15	* See the License for the specific language governing permissions and
16	* limitations under the License.
17	*/
18	package org.jreleaser.model.internal.upload;
19
20	import com.fasterxml.jackson.annotation.JsonIgnore;
21	import org.jreleaser.model.Active;
22	import org.jreleaser.model.internal.JReleaserContext;
23	import org.jreleaser.model.internal.common.Artifact;
24	import org.jreleaser.mustache.TemplateContext;
25
26	import java.util.LinkedHashMap;
27	import java.util.Map;
28
29	import static java.util.Collections.unmodifiableMap;
30	import static org.jreleaser.model.Constants.HIDE;
31	import static org.jreleaser.model.Constants.UNSET;
32	import static org.jreleaser.model.api.upload.S3Uploader.TYPE;
33	import static org.jreleaser.mustache.Templates.resolveTemplate;
34	import static org.jreleaser.util.StringUtils.capitalize;
35	import static org.jreleaser.util.StringUtils.isBlank;
36	import static org.jreleaser.util.StringUtils.isNotBlank;
37
38	/**
39	* @author Andres Almiray
40	* @since 0.8.0
41	*/
42	public final class S3Uploader extends AbstractUploader<org.jreleaser.model.api.upload.S3Uploader, S3Uploader> {
43	private static final long serialVersionUID = -747298261100208723L;
44
45	private final Map<String, String> headers = new LinkedHashMap<>();	1✔
46
47	private String region;
48	private String bucket;
49	private String path;
50	private String downloadUrl;
51	private String endpoint;
52	private String accessKeyId;
53	private String secretKey;
54	private String sessionToken;
55
56	@JsonIgnore	1✔
57	private final org.jreleaser.model.api.upload.S3Uploader immutable = new org.jreleaser.model.api.upload.S3Uploader() {	1✔
58	private static final long serialVersionUID = -3263159021072324345L;
59
60	@Override
61	public String getRegion() {
62	return region;	×
63	}
64
65	@Override
66	public String getBucket() {
67	return bucket;	×
68	}
69
70	@Override
71	public String getAccessKeyId() {
72	return accessKeyId;	×
73	}
74
75	@Override
76	public String getSecretKey() {
77	return secretKey;	×
78	}
79
80	@Override
81	public String getSessionToken() {
82	return sessionToken;	×
83	}
84
85	@Override
86	public String getPath() {
87	return path;	×
88	}
89
90	@Override
91	public String getDownloadUrl() {
92	return downloadUrl;	×
93	}
94
95	@Override
96	public String getEndpoint() {
97	return endpoint;	×
98	}
99
100	@Override
101	public Map<String, String> getHeaders() {
102	return unmodifiableMap(headers);	×
103	}
104
105	@Override
106	public String getType() {
107	return S3Uploader.this.getType();	×
108	}
109
110	@Override
111	public String getName() {
112	return S3Uploader.this.getName();	×
113	}
114
115	@Override
116	public boolean isSnapshotSupported() {
117	return S3Uploader.this.isSnapshotSupported();	×
118	}
119
120	@Override
121	public boolean isArtifacts() {
122	return S3Uploader.this.isArtifacts();	×
123	}
124
125	@Override
126	public boolean isFiles() {
127	return S3Uploader.this.isFiles();	×
128	}
129
130	@Override
131	public boolean isSignatures() {
132	return S3Uploader.this.isSignatures();	×
133	}
134
135	@Override
136	public boolean isChecksums() {
137	return S3Uploader.this.isChecksums();	×
138	}
139
140	@Override
141	public boolean isCatalogs() {
142	return S3Uploader.this.isCatalogs();	×
143	}
144
145	@Override
146	public Active getActive() {
147	return S3Uploader.this.getActive();	×
148	}
149
150	@Override
151	public boolean isEnabled() {
152	return S3Uploader.this.isEnabled();	×
153	}
154
155	@Override
156	public Map<String, Object> asMap(boolean full) {
157	return unmodifiableMap(S3Uploader.this.asMap(full));	×
158	}
159
160	@Override
161	public String getPrefix() {
162	return S3Uploader.this.prefix();	×
163	}
164
165	@Override
166	public Map<String, Object> getExtraProperties() {
167	return unmodifiableMap(S3Uploader.this.getExtraProperties());	×
168	}
169
170	@Override
171	public Integer getConnectTimeout() {
172	return S3Uploader.this.getConnectTimeout();	×
173	}
174
175	@Override
176	public Integer getReadTimeout() {
177	return S3Uploader.this.getReadTimeout();	×
178	}
179	};
180
181	public S3Uploader() {
182	super(TYPE);	1✔
183	}	1✔
184
185	@Override
186	public org.jreleaser.model.api.upload.S3Uploader asImmutable() {
187	return immutable;	1✔
188	}
189
190	@Override
191	public void merge(S3Uploader source) {
192	super.merge(source);	×
193	this.region = merge(this.region, source.region);	×
194	this.bucket = merge(this.bucket, source.bucket);	×
195	this.path = merge(this.path, source.path);	×
196	this.downloadUrl = merge(this.downloadUrl, source.downloadUrl);	×
197	this.endpoint = merge(this.endpoint, source.endpoint);	×
198	this.accessKeyId = merge(this.accessKeyId, source.accessKeyId);	×
199	this.secretKey = merge(this.secretKey, source.secretKey);	×
200	this.sessionToken = merge(this.sessionToken, source.sessionToken);	×
201	setHeaders(merge(this.headers, source.headers));	×
202	}	×
203
204	@Override
205	public String getResolvedDownloadUrl(JReleaserContext context, Artifact artifact) {
206	return getResolvedDownloadUrl(context, context.fullProps(), artifact);	1✔
207	}
208
209	@Override
210	public String getResolvedDownloadUrl(JReleaserContext context, TemplateContext props, Artifact artifact) {
211	if (isNotBlank(getDownloadUrl())) {	1✔
212	TemplateContext p = new TemplateContext(artifactProps(props, artifact));	×
213	p.setAll(resolvedExtraProperties());	×
214	p.set("bucket", bucket);	×
215	p.set("region", region);	×
NEW 216	return resolveTemplate(context.getLogger(), getDownloadUrl(), p);	×
217	}
218
219	if (isBlank(getEndpoint())) {	1✔
220	String url = "https://{{bucket}}.s3.{{region}}.amazonaws.com/" + path;	1✔
221	TemplateContext p = new TemplateContext(artifactProps(props, artifact));	1✔
222	p.setAll(resolvedExtraProperties());	1✔
223	p.set("bucket", bucket);	1✔
224	p.set("region", region);	1✔
225	return resolveTemplate(context.getLogger(), url, p);	1✔
226	}
227
228	return "";	×
229	}
230
231	public String getRegion() {
232	return region;	1✔
233	}
234
235	public void setRegion(String region) {
236	this.region = region;	1✔
237	}	1✔
238
239	public String getBucket() {
240	return bucket;	1✔
241	}
242
243	public void setBucket(String bucket) {
244	this.bucket = bucket;	1✔
245	}	1✔
246
247	public String getAccessKeyId() {
248	return accessKeyId;	1✔
249	}
250
251	public void setAccessKeyId(String accessKeyId) {
252	this.accessKeyId = accessKeyId;	1✔
253	}	1✔
254
255	public String getSecretKey() {
256	return secretKey;	1✔
257	}
258
259	public void setSecretKey(String secretKey) {
260	this.secretKey = secretKey;	1✔
261	}	1✔
262
263	public String getSessionToken() {
264	return sessionToken;	1✔
265	}
266
267	public void setSessionToken(String sessionToken) {
268	this.sessionToken = sessionToken;	1✔
269	}	1✔
270
271	public String getPath() {
272	return path;	1✔
273	}
274
275	public void setPath(String path) {
276	this.path = path;	1✔
277	}	1✔
278
279	public String getDownloadUrl() {
280	return downloadUrl;	1✔
281	}
282
283	public void setDownloadUrl(String downloadUrl) {
284	this.downloadUrl = downloadUrl;	1✔
285	}	1✔
286
287	public String getEndpoint() {
288	return endpoint;	1✔
289	}
290
291	public void setEndpoint(String endpoint) {
292	this.endpoint = endpoint;	1✔
293	}	1✔
294
295	public Map<String, String> getHeaders() {
296	return headers;	1✔
297	}
298
299	public void setHeaders(Map<String, String> headers) {
300	this.headers.putAll(headers);	×
301	}	×
302
303	@Override
304	protected void asMap(boolean full, Map<String, Object> props) {
305	props.put("region", region);	1✔
306	props.put("bucket", bucket);	1✔
307	props.put("accessKeyId", isNotBlank(accessKeyId) ? HIDE : UNSET);	1✔
308	props.put("secretKey", isNotBlank(secretKey) ? HIDE : UNSET);	1✔
309	props.put("sessionToken", isNotBlank(sessionToken) ? HIDE : UNSET);	1✔
310	props.put("path", path);	1✔
311	props.put("downloadUrl", downloadUrl);	1✔
312	props.put("endpoint", endpoint);	1✔
313	props.put("headers", headers);	1✔
314	}	1✔
315
316
317	public String getResolvedPath(JReleaserContext context, Artifact artifact) {
318	String artifactPath = path;	1✔
319
320	String customPathKey = "s3" + capitalize(getName()) + "Path";	1✔
321	if (artifact.getExtraProperties().containsKey(customPathKey)) {	1✔
322	artifactPath = artifact.getExtraProperty(customPathKey);	×
323	}
324
325	TemplateContext p = new TemplateContext(artifactProps(context, artifact));	1✔
326	p.setAll(resolvedExtraProperties());	1✔
327	return resolveTemplate(context.getLogger(), artifactPath, p);	1✔
328	}
329	}

jreleaser / jreleaser / #558

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous