#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/ScoopPackagerProcessor.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.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.common.Artifact;
import org.jreleaser.model.internal.distributions.Distribution;
import org.jreleaser.model.internal.packagers.ScoopPackager;
import org.jreleaser.model.internal.release.BaseReleaser;
import org.jreleaser.model.internal.util.Artifacts;
import org.jreleaser.model.spi.packagers.PackagerProcessingException;
import org.jreleaser.mustache.TemplateContext;

import java.nio.file.Path;

import static org.jreleaser.model.Constants.KEY_ARTIFACT_FILE;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT;
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_PROJECT_EFFECTIVE_VERSION;
import static org.jreleaser.model.Constants.KEY_PROJECT_VERSION;
import static org.jreleaser.model.Constants.KEY_SCOOP_AUTOUPDATE_EXTRACT_DIR;
import static org.jreleaser.model.Constants.KEY_SCOOP_AUTOUPDATE_URL;
import static org.jreleaser.model.Constants.KEY_SCOOP_BUCKET_REPO_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_SCOOP_BUCKET_REPO_URL;
import static org.jreleaser.model.Constants.KEY_SCOOP_CHECKVER_URL;
import static org.jreleaser.model.Constants.KEY_SCOOP_PACKAGE_NAME;
import static org.jreleaser.model.Constants.KEY_SCOOP_REPOSITORY_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_SCOOP_REPOSITORY_URL;
import static org.jreleaser.model.Constants.KEY_TAG_NAME;
import static org.jreleaser.mustache.Templates.resolveTemplate;
import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
import static org.jreleaser.util.StringUtils.isBlank;

/**
 * @author Andres Almiray
 * @since 0.1.0
 */
public class ScoopPackagerProcessor extends AbstractRepositoryPackagerProcessor<ScoopPackager> {
    public ScoopPackagerProcessor(JReleaserContext context) {
        super(context);
    }

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

    @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());
        BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();

        props.set(KEY_SCOOP_BUCKET_REPO_URL,
            releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_SCOOP_BUCKET_REPO_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_SCOOP_REPOSITORY_URL,
            releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_SCOOP_REPOSITORY_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));

        props.set(KEY_SCOOP_PACKAGE_NAME, packager.getPackageName());
        props.set(KEY_SCOOP_CHECKVER_URL, resolveCheckverUrl(props));
        props.set(KEY_SCOOP_AUTOUPDATE_URL, resolveAutoupdateUrl(props, distribution));
        String autoupdateExtractDir = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE_NAME);
        autoupdateExtractDir = autoupdateExtractDir.replace(context.getModel().getProject().getEffectiveVersion(), "$version");
        props.set(KEY_SCOOP_AUTOUPDATE_EXTRACT_DIR, autoupdateExtractDir);
    }

    private Object resolveCheckverUrl(TemplateContext props) {
        if (!getPackager().getCheckverUrl().contains("{{")) {
            return getPackager().getCheckverUrl();
        }
        return resolveTemplate(getPackager().getCheckverUrl(), props);
    }

    private Object resolveAutoupdateUrl(TemplateContext props, Distribution distribution) {
        String url = getPackager().getAutoupdateUrl();
        if (isBlank(url)) {
            Artifact artifact = props.get(KEY_DISTRIBUTION_ARTIFACT);
            url = Artifacts.resolveDownloadUrl(context, org.jreleaser.model.api.packagers.ScoopPackager.TYPE, distribution, artifact);
        }

        String artifactFile = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE);
        String projectVersion = props.get(KEY_PROJECT_VERSION);
        String tagName = props.get(KEY_TAG_NAME);
        url = url.replace(projectVersion, "$version");
        artifactFile = artifactFile.replace(projectVersion, "$version");
        tagName = tagName.replace(projectVersion, "$version");

        TemplateContext copy = new TemplateContext(props);
        copy.set(KEY_PROJECT_VERSION, "$version");
        copy.set(KEY_PROJECT_EFFECTIVE_VERSION, "$version");
        copy.set(KEY_TAG_NAME, tagName);
        copy.set(KEY_ARTIFACT_FILE, artifactFile);
        return resolveTemplate(url, copy);
    }

    @Override
    protected void writeFile(Distribution distribution,
                             String content,
                             TemplateContext props,
                             Path outputDirectory,
                             String fileName) throws PackagerProcessingException {
        fileName = trimTplExtension(fileName);

        Path outputFile = "manifest.json".equals(fileName) ?
            outputDirectory.resolve("bucket").resolve(packager.getPackageName().concat(".json")) :
            outputDirectory.resolve(fileName);

        writeFile(content, 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.jreleaser.model.internal.JReleaserContext;
21	import org.jreleaser.model.internal.common.Artifact;
22	import org.jreleaser.model.internal.distributions.Distribution;
23	import org.jreleaser.model.internal.packagers.ScoopPackager;
24	import org.jreleaser.model.internal.release.BaseReleaser;
25	import org.jreleaser.model.internal.util.Artifacts;
26	import org.jreleaser.model.spi.packagers.PackagerProcessingException;
27	import org.jreleaser.mustache.TemplateContext;
28
29	import java.nio.file.Path;
30
31	import static org.jreleaser.model.Constants.KEY_ARTIFACT_FILE;
32	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT;
33	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE;
34	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_ARTIFACT_FILE_NAME;
35	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
36	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
37	import static org.jreleaser.model.Constants.KEY_PROJECT_EFFECTIVE_VERSION;
38	import static org.jreleaser.model.Constants.KEY_PROJECT_VERSION;
39	import static org.jreleaser.model.Constants.KEY_SCOOP_AUTOUPDATE_EXTRACT_DIR;
40	import static org.jreleaser.model.Constants.KEY_SCOOP_AUTOUPDATE_URL;
41	import static org.jreleaser.model.Constants.KEY_SCOOP_BUCKET_REPO_CLONE_URL;
42	import static org.jreleaser.model.Constants.KEY_SCOOP_BUCKET_REPO_URL;
43	import static org.jreleaser.model.Constants.KEY_SCOOP_CHECKVER_URL;
44	import static org.jreleaser.model.Constants.KEY_SCOOP_PACKAGE_NAME;
45	import static org.jreleaser.model.Constants.KEY_SCOOP_REPOSITORY_CLONE_URL;
46	import static org.jreleaser.model.Constants.KEY_SCOOP_REPOSITORY_URL;
47	import static org.jreleaser.model.Constants.KEY_TAG_NAME;
48	import static org.jreleaser.mustache.Templates.resolveTemplate;
49	import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
50	import static org.jreleaser.util.StringUtils.isBlank;
51
52	/**
53	* @author Andres Almiray
54	* @since 0.1.0
55	*/
56	public class ScoopPackagerProcessor extends AbstractRepositoryPackagerProcessor<ScoopPackager> {
57	public ScoopPackagerProcessor(JReleaserContext context) {
UNCOV 58	super(context);	×
UNCOV 59	}	×
60
61	@Override
62	protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
UNCOV 63	super.doPackageDistribution(distribution, props, packageDirectory);	×
UNCOV 64	copyPreparedFiles(props);	×
UNCOV 65	}	×
66
67	@Override
68	protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
UNCOV 69	props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());	×
UNCOV 70	props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());	×
UNCOV 71	BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();	×
72
UNCOV 73	props.set(KEY_SCOOP_BUCKET_REPO_URL,	×
UNCOV 74	releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	×
UNCOV 75	props.set(KEY_SCOOP_BUCKET_REPO_CLONE_URL,	×
UNCOV 76	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	×
UNCOV 77	props.set(KEY_SCOOP_REPOSITORY_URL,	×
UNCOV 78	releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	×
UNCOV 79	props.set(KEY_SCOOP_REPOSITORY_CLONE_URL,	×
UNCOV 80	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	×
81
UNCOV 82	props.set(KEY_SCOOP_PACKAGE_NAME, packager.getPackageName());	×
UNCOV 83	props.set(KEY_SCOOP_CHECKVER_URL, resolveCheckverUrl(props));	×
UNCOV 84	props.set(KEY_SCOOP_AUTOUPDATE_URL, resolveAutoupdateUrl(props, distribution));	×
UNCOV 85	String autoupdateExtractDir = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE_NAME);	×
UNCOV 86	autoupdateExtractDir = autoupdateExtractDir.replace(context.getModel().getProject().getEffectiveVersion(), "$version");	×
UNCOV 87	props.set(KEY_SCOOP_AUTOUPDATE_EXTRACT_DIR, autoupdateExtractDir);	×
UNCOV 88	}	×
89
90	private Object resolveCheckverUrl(TemplateContext props) {
UNCOV 91	if (!getPackager().getCheckverUrl().contains("{{")) {	×
92	return getPackager().getCheckverUrl();	×
93	}
UNCOV 94	return resolveTemplate(getPackager().getCheckverUrl(), props);	×
95	}
96
97	private Object resolveAutoupdateUrl(TemplateContext props, Distribution distribution) {
UNCOV 98	String url = getPackager().getAutoupdateUrl();	×
UNCOV 99	if (isBlank(url)) {	×
UNCOV 100	Artifact artifact = props.get(KEY_DISTRIBUTION_ARTIFACT);	×
UNCOV 101	url = Artifacts.resolveDownloadUrl(context, org.jreleaser.model.api.packagers.ScoopPackager.TYPE, distribution, artifact);	×
102	}
103
UNCOV 104	String artifactFile = props.get(KEY_DISTRIBUTION_ARTIFACT_FILE);	×
UNCOV 105	String projectVersion = props.get(KEY_PROJECT_VERSION);	×
UNCOV 106	String tagName = props.get(KEY_TAG_NAME);	×
UNCOV 107	url = url.replace(projectVersion, "$version");	×
UNCOV 108	artifactFile = artifactFile.replace(projectVersion, "$version");	×
UNCOV 109	tagName = tagName.replace(projectVersion, "$version");	×
110
UNCOV 111	TemplateContext copy = new TemplateContext(props);	×
UNCOV 112	copy.set(KEY_PROJECT_VERSION, "$version");	×
UNCOV 113	copy.set(KEY_PROJECT_EFFECTIVE_VERSION, "$version");	×
UNCOV 114	copy.set(KEY_TAG_NAME, tagName);	×
UNCOV 115	copy.set(KEY_ARTIFACT_FILE, artifactFile);	×
UNCOV 116	return resolveTemplate(url, copy);	×
117	}
118
119	@Override
120	protected void writeFile(Distribution distribution,
121	String content,
122	TemplateContext props,
123	Path outputDirectory,
124	String fileName) throws PackagerProcessingException {
UNCOV 125	fileName = trimTplExtension(fileName);	×
126
UNCOV 127	Path outputFile = "manifest.json".equals(fileName) ?	×
UNCOV 128	outputDirectory.resolve("bucket").resolve(packager.getPackageName().concat(".json")) :	×
UNCOV 129	outputDirectory.resolve(fileName);	×
130
UNCOV 131	writeFile(content, outputFile);	×
UNCOV 132	}	×
133	}

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