#475

Committed 03 Apr 2025 10:50AM UTC coverage: 40.322% (-8.9%) from 49.193%

Build # #475

Build Type

push

github

Committed by

aalmiray

Commit Message

feat(release): Support Forgejo as releaser

Closes #1842

Closes #1843

Coverage Stats

182 of 1099 new or added lines in 45 files covered. (16.56%)

4239 existing lines in 333 files now uncovered.

20797 of 51577 relevant lines covered (40.32%)

0.4 hits per line

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

0.0

/core/jreleaser-engine/src/main/java/org/jreleaser/packagers/AppImagePackagerProcessor.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.packagers;

import org.apache.commons.lang3.StringUtils;
import org.jreleaser.bundle.RB;
import org.jreleaser.engine.release.Releasers;
import org.jreleaser.model.Stereotype;
import org.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.common.Screenshot;
import org.jreleaser.model.internal.distributions.Distribution;
import org.jreleaser.model.internal.packagers.AppImagePackager;
import org.jreleaser.model.internal.release.BaseReleaser;
import org.jreleaser.model.internal.release.GithubReleaser;
import org.jreleaser.model.internal.release.Releaser;
import org.jreleaser.model.spi.packagers.PackagerProcessingException;
import org.jreleaser.mustache.TemplateContext;

import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Path;
import java.util.Optional;

import static java.util.stream.Collectors.toList;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_CATEGORIES;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_CATEGORIES_BY_COMMA;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_COMPONENT_ID;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_DEVELOPER_NAME;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE_NAME;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_URL;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_ICONS;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_RELEASES;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPOSITORY_NAME;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPOSITORY_OWNER;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPO_NAME;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPO_OWNER;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_REQUIRES_TERMINAL;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_SCREENSHOTS;
import static org.jreleaser.model.Constants.KEY_APPIMAGE_URLS;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE_NAME;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_URL;
import static org.jreleaser.model.Constants.KEY_PROJECT_AUTHORS;
import static org.jreleaser.packagers.AppdataUtils.isReleaseIncluded;
import static org.jreleaser.packagers.AppdataUtils.resolveIcons;
import static org.jreleaser.templates.TemplateUtils.trimTplExtension;

/**
 * @author Andres Almiray
 * @since 1.2.0
 */
public class AppImagePackagerProcessor extends AbstractRepositoryPackagerProcessor<AppImagePackager> {
    public AppImagePackagerProcessor(JReleaserContext context) {
        super(context);
    }

    @Override
    protected void doPrepareDistribution(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
        setupPrepare(distribution, props);
        super.doPrepareDistribution(distribution, props);
    }

    @Override
    protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
        super.doPackageDistribution(distribution, props, packageDirectory);
        copyPreparedFiles(props);
    }

    private void setupPrepare(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
        BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();

        try {
            props.set(KEY_APPIMAGE_RELEASES, Releasers.releaserFor(context)
                .listReleases(releaser.getOwner(), releaser.getName()).stream()
                .filter(r -> isReleaseIncluded(packager.getSkipReleases(), r.getVersion().toString()))
                .map(r -> AppdataUtils.Release.of(r.getUrl(), r.getVersion().toString(), r.getPublishedAt()))
                .collect(toList()));
        } catch (IOException e) {
            throw new PackagerProcessingException(RB.$("ERROR_unexpected_error"), e);
        }

        props.set(KEY_APPIMAGE_SCREENSHOTS, packager.getScreenshots().stream()
            .map(Screenshot::asScreenshotTemplate)
            .collect(toList()));

        context.getLogger().debug(RB.$("packager.fetch.icons"));
        props.set(KEY_APPIMAGE_ICONS, packager.getIcons());
        resolveIcons(context, packager, distribution, props, packager.getIcons());
    }

    @Override
    protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
        props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());
        props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());
        props.set(KEY_PROJECT_AUTHORS, context.getModel().getProject().getAuthors());
        props.set(KEY_APPIMAGE_URLS, context.getModel().getProject().getLinks().asLinkTemplates(false));
        props.set(KEY_APPIMAGE_COMPONENT_ID, getPackager().getComponentId());
        props.set(KEY_APPIMAGE_CATEGORIES, getPackager().getCategories());
        props.set(KEY_APPIMAGE_CATEGORIES_BY_COMMA, String.join(",", getPackager().getCategories()));
        props.set(KEY_APPIMAGE_DEVELOPER_NAME, getPackager().getDeveloperName());
        props.set(KEY_APPIMAGE_REQUIRES_TERMINAL, getPackager().isRequiresTerminal());
        props.set(KEY_APPIMAGE_REPO_OWNER, packager.getRepository().getOwner());
        props.set(KEY_APPIMAGE_REPO_NAME, packager.getRepository().getName());
        props.set(KEY_APPIMAGE_REPOSITORY_OWNER, packager.getRepository().getOwner());
        props.set(KEY_APPIMAGE_REPOSITORY_NAME, packager.getRepository().getName());

        BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();
        String str = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE);
        str = str.replace(context.getModel().getProject().getEffectiveVersion(), "${DISTRIBUTION_VERSION}");
        props.set(KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE, str);
        str = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE_NAME);
        str = str.replace(context.getModel().getProject().getEffectiveVersion(), "${DISTRIBUTION_VERSION}");
        props.set(KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE_NAME, str);
        str = props.get(KEY_DISTRIBUTION_URL);
        str = str.replace(releaser.getEffectiveTagName(context.getModel()), "${DISTRIBUTION_TAG}")
            .replace(props.get(KEY_DISTRIBUTION_ARTIFACT_FILE), "${DISTRIBUTION_FILE}");
        props.set(KEY_APPIMAGE_DISTRIBUTION_URL, str);
    }

    @Override
    protected void writeFile(Distribution distribution,
                             String content,
                             TemplateContext props,
                             Path outputDirectory,
                             String fileName) throws PackagerProcessingException {
        Releaser<?> gitService = context.getModel().getRelease().getReleaser();
        if (fileName.contains("github") && !(gitService instanceof GithubReleaser)) {
            // skip
            return;
        } else if (fileName.contains("-github")) {
            fileName = StringUtils.remove(fileName, "-github");
        }

        fileName = trimTplExtension(fileName);
        Optional<Stereotype> stereotype = resolveStereotype(fileName);
        if (stereotype.isPresent()) {
            if (distribution.getStereotype() == stereotype.get()) {
                fileName = fileName.substring(distribution.getStereotype().formatted().length() + 1);
            } else {
                // skip it
                return;
            }
        }

        Path outputFile = outputDirectory.resolve(fileName);

        if ("app.desktop".equals(fileName)) {
            outputFile = outputDirectory.resolve(distribution.getExecutable().getName() + ".desktop");
        } else if ("appdata.xml".equals(fileName)) {
            outputFile = outputDirectory.resolve(getPackager().getComponentId() + ".appdata.xml");
        }

        writeFile(content, outputFile);
    }

    @Override
    protected void writeFile(Distribution distribution, InputStream inputStream, TemplateContext props, Path outputDirectory, String fileName) throws PackagerProcessingException {
        Path outputFile = outputDirectory.resolve(fileName);

        if (fileName.endsWith("app.png")) {
            outputFile = outputDirectory.resolve(fileName.replace("app", distribution.getExecutable().getName()));
        }

        writeFile(inputStream, outputFile);
    }
}

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.packagers;
19
20	import org.apache.commons.lang3.StringUtils;
21	import org.jreleaser.bundle.RB;
22	import org.jreleaser.engine.release.Releasers;
23	import org.jreleaser.model.Stereotype;
24	import org.jreleaser.model.internal.JReleaserContext;
25	import org.jreleaser.model.internal.common.Screenshot;
26	import org.jreleaser.model.internal.distributions.Distribution;
27	import org.jreleaser.model.internal.packagers.AppImagePackager;
28	import org.jreleaser.model.internal.release.BaseReleaser;
29	import org.jreleaser.model.internal.release.GithubReleaser;
30	import org.jreleaser.model.internal.release.Releaser;
31	import org.jreleaser.model.spi.packagers.PackagerProcessingException;
32	import org.jreleaser.mustache.TemplateContext;
33
34	import java.io.IOException;
35	import java.io.InputStream;
36	import java.nio.file.Path;
37	import java.util.Optional;
38
39	import static java.util.stream.Collectors.toList;
40	import static org.jreleaser.model.Constants.KEY_APPIMAGE_CATEGORIES;
41	import static org.jreleaser.model.Constants.KEY_APPIMAGE_CATEGORIES_BY_COMMA;
42	import static org.jreleaser.model.Constants.KEY_APPIMAGE_COMPONENT_ID;
43	import static org.jreleaser.model.Constants.KEY_APPIMAGE_DEVELOPER_NAME;
44	import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE;
45	import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE_NAME;
46	import static org.jreleaser.model.Constants.KEY_APPIMAGE_DISTRIBUTION_URL;
47	import static org.jreleaser.model.Constants.KEY_APPIMAGE_ICONS;
48	import static org.jreleaser.model.Constants.KEY_APPIMAGE_RELEASES;
49	import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPOSITORY_NAME;
50	import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPOSITORY_OWNER;
51	import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPO_NAME;
52	import static org.jreleaser.model.Constants.KEY_APPIMAGE_REPO_OWNER;
53	import static org.jreleaser.model.Constants.KEY_APPIMAGE_REQUIRES_TERMINAL;
54	import static org.jreleaser.model.Constants.KEY_APPIMAGE_SCREENSHOTS;
55	import static org.jreleaser.model.Constants.KEY_APPIMAGE_URLS;
56	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE;
57	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE_NAME;
58	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
59	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
60	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_URL;
61	import static org.jreleaser.model.Constants.KEY_PROJECT_AUTHORS;
62	import static org.jreleaser.packagers.AppdataUtils.isReleaseIncluded;
63	import static org.jreleaser.packagers.AppdataUtils.resolveIcons;
64	import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
65
66	/**
67	* @author Andres Almiray
68	* @since 1.2.0
69	*/
70	public class AppImagePackagerProcessor extends AbstractRepositoryPackagerProcessor<AppImagePackager> {
71	public AppImagePackagerProcessor(JReleaserContext context) {
UNCOV 72	super(context);	×
UNCOV 73	}	×
74
75	@Override
76	protected void doPrepareDistribution(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
77	setupPrepare(distribution, props);	×
78	super.doPrepareDistribution(distribution, props);	×
79	}	×
80
81	@Override
82	protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
83	super.doPackageDistribution(distribution, props, packageDirectory);	×
84	copyPreparedFiles(props);	×
85	}	×
86
87	private void setupPrepare(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
88	BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();	×
89
90	try {
91	props.set(KEY_APPIMAGE_RELEASES, Releasers.releaserFor(context)	×
92	.listReleases(releaser.getOwner(), releaser.getName()).stream()	×
93	.filter(r -> isReleaseIncluded(packager.getSkipReleases(), r.getVersion().toString()))	×
94	.map(r -> AppdataUtils.Release.of(r.getUrl(), r.getVersion().toString(), r.getPublishedAt()))	×
95	.collect(toList()));	×
96	} catch (IOException e) {	×
97	throw new PackagerProcessingException(RB.$("ERROR_unexpected_error"), e);	×
98	}	×
99
100	props.set(KEY_APPIMAGE_SCREENSHOTS, packager.getScreenshots().stream()	×
101	.map(Screenshot::asScreenshotTemplate)	×
102	.collect(toList()));	×
103
104	context.getLogger().debug(RB.$("packager.fetch.icons"));	×
105	props.set(KEY_APPIMAGE_ICONS, packager.getIcons());	×
106	resolveIcons(context, packager, distribution, props, packager.getIcons());	×
107	}	×
108
109	@Override
110	protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
111	props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());	×
112	props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());	×
113	props.set(KEY_PROJECT_AUTHORS, context.getModel().getProject().getAuthors());	×
114	props.set(KEY_APPIMAGE_URLS, context.getModel().getProject().getLinks().asLinkTemplates(false));	×
115	props.set(KEY_APPIMAGE_COMPONENT_ID, getPackager().getComponentId());	×
116	props.set(KEY_APPIMAGE_CATEGORIES, getPackager().getCategories());	×
117	props.set(KEY_APPIMAGE_CATEGORIES_BY_COMMA, String.join(",", getPackager().getCategories()));	×
118	props.set(KEY_APPIMAGE_DEVELOPER_NAME, getPackager().getDeveloperName());	×
119	props.set(KEY_APPIMAGE_REQUIRES_TERMINAL, getPackager().isRequiresTerminal());	×
120	props.set(KEY_APPIMAGE_REPO_OWNER, packager.getRepository().getOwner());	×
121	props.set(KEY_APPIMAGE_REPO_NAME, packager.getRepository().getName());	×
122	props.set(KEY_APPIMAGE_REPOSITORY_OWNER, packager.getRepository().getOwner());	×
123	props.set(KEY_APPIMAGE_REPOSITORY_NAME, packager.getRepository().getName());	×
124
125	BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();	×
126	String str = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE);	×
127	str = str.replace(context.getModel().getProject().getEffectiveVersion(), "${DISTRIBUTION_VERSION}");	×
128	props.set(KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE, str);	×
129	str = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE_NAME);	×
130	str = str.replace(context.getModel().getProject().getEffectiveVersion(), "${DISTRIBUTION_VERSION}");	×
131	props.set(KEY_APPIMAGE_DISTRIBUTION_ARTIFACT_FILE_NAME, str);	×
132	str = props.get(KEY_DISTRIBUTION_URL);	×
133	str = str.replace(releaser.getEffectiveTagName(context.getModel()), "${DISTRIBUTION_TAG}")	×
134	.replace(props.get(KEY_DISTRIBUTION_ARTIFACT_FILE), "${DISTRIBUTION_FILE}");	×
135	props.set(KEY_APPIMAGE_DISTRIBUTION_URL, str);	×
136	}	×
137
138	@Override
139	protected void writeFile(Distribution distribution,
140	String content,
141	TemplateContext props,
142	Path outputDirectory,
143	String fileName) throws PackagerProcessingException {
144	Releaser<?> gitService = context.getModel().getRelease().getReleaser();	×
145	if (fileName.contains("github") && !(gitService instanceof GithubReleaser)) {	×
146	// skip
147	return;	×
148	} else if (fileName.contains("-github")) {	×
149	fileName = StringUtils.remove(fileName, "-github");	×
150	}
151
152	fileName = trimTplExtension(fileName);	×
153	Optional<Stereotype> stereotype = resolveStereotype(fileName);	×
154	if (stereotype.isPresent()) {	×
155	if (distribution.getStereotype() == stereotype.get()) {	×
156	fileName = fileName.substring(distribution.getStereotype().formatted().length() + 1);	×
157	} else {
158	// skip it
159	return;	×
160	}
161	}
162
163	Path outputFile = outputDirectory.resolve(fileName);	×
164
165	if ("app.desktop".equals(fileName)) {	×
166	outputFile = outputDirectory.resolve(distribution.getExecutable().getName() + ".desktop");	×
167	} else if ("appdata.xml".equals(fileName)) {	×
168	outputFile = outputDirectory.resolve(getPackager().getComponentId() + ".appdata.xml");	×
169	}
170
171	writeFile(content, outputFile);	×
172	}	×
173
174	@Override
175	protected void writeFile(Distribution distribution, InputStream inputStream, TemplateContext props, Path outputDirectory, String fileName) throws PackagerProcessingException {
176	Path outputFile = outputDirectory.resolve(fileName);	×
177
178	if (fileName.endsWith("app.png")) {	×
179	outputFile = outputDirectory.resolve(fileName.replace("app", distribution.getExecutable().getName()));	×
180	}
181
182	writeFile(inputStream, outputFile);	×
183	}	×
184	}

jreleaser / jreleaser / #475

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