Access to Info variables (git commit) as config properties?

[rcoup]

Goal: pass the build commit sha to sentry as the release variable.

It's baked into the Quarkus Info extension at build time and available through /q/info, but is there a way the data could be exposed as config properties?

My fallback is to use something like the maven git commit id plugin to write a git.properties file, get Quarkus to pick that up, and populate quarkus.log.sentry.release from that.

Any other suggestions? Thanks! 😄

[quarkus-bot[bot]]

/cc @radcortez (config)

[radcortez]

You should be able to retrieve this from GitInfo CDI Bean. Is this enough?

[rcoup]

I basically want to set quarkus.log.sentry.release=c0ffeec0ffeec0ffee in application.properties... but AFAICT the GitInfo isn't exposed at config-time?

FWIW, my workaround atm is below, but I don't really want to use a maven plugin.

pom.xml

<plugin>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-maven-plugin</artifactId>
    <version>9.0.2</version>
    <executions>
        <execution>
            <id>git-commit-info</id>
            <goals>
                <goal>revision</goal>
            </goals>
            <phase>initialize</phase>
        </execution>
    </executions>
    <configuration>
        <generateGitPropertiesFile>true</generateGitPropertiesFile>
        <generateGitPropertiesFilename>
            ${project.build.outputDirectory}/META-INF/microprofile-config.properties
        </generateGitPropertiesFilename>
        <commitIdGenerationMode>full</commitIdGenerationMode>
        <useNativeGit>true</useNativeGit>
    </configuration>
</plugin>

application.properties

quarkus.log.sentry.release=${git.commit.id.full}

[radcortez]

One possibility is to generate a config builder at the processor level that records the required config and set quarkus.log.sentry.release. Should quarkus.log.sentry.release be a runtime property?

We can probably consider to change the info configuration to be build time runtime fixed.

[rcoup]

I think it's very common to use a Git sha as a release id, but it's also very common to use something completely different...

[radcortez]

Yes, so the issue is that the Git info is not a configuration, but inferred from the repo and recorded in the info endpoint:

quarkus/extensions/info/deployment/src/main/java/io/quarkus/info/deployment/InfoProcessor.java

Lines 58 to 136 in dcd6f3e

	@BuildStep(onlyIf = GitInInfoEndpointEnabled.class)
	@Record(ExecutionTime.RUNTIME_INIT)
	void gitInfo(InfoBuildTimeConfig config,
	CurateOutcomeBuildItem curateOutcomeBuildItem,
	OutputTargetBuildItem outputTargetBuildItem,
	BuildProducer<InfoBuildTimeValuesBuildItem> valuesProducer,
	BuildProducer<SyntheticBeanBuildItem> beanProducer,
	InfoRecorder recorder) {
	File projectRoot = highestKnownProjectDirectory(curateOutcomeBuildItem, outputTargetBuildItem);
	if (projectRoot == null) {
	log.debug("Unable to determine project directory");
	return;
	}
	RepositoryBuilder repositoryBuilder = new RepositoryBuilder().findGitDir(projectRoot);
	if (repositoryBuilder.getGitDir() == null) {
	log.debug("Project is not checked in to git");
	return;
	}
	try (Repository repository = repositoryBuilder.build();
	Git git = Git.wrap(repository)) {
	RevCommit latestCommit = git.log().setMaxCount(1).call().iterator().next();
	boolean addFullInfo = config.git().mode() == InfoBuildTimeConfig.Git.Mode.FULL;
	Map<String, Object> data = new LinkedHashMap<>();
	String branch = repository.getBranch();
	data.put("branch", branch);
	Map<String, Object> commit = new LinkedHashMap<>();
	String latestCommitId = latestCommit.getName();
	commit.put("id", latestCommitId);
	String latestCommitTime = formatDate(Instant.ofEpochSecond(latestCommit.getCommitTime()), ZoneId.systemDefault());
	commit.put("time", latestCommitTime);
	if (addFullInfo) {
	PersonIdent authorIdent = latestCommit.getAuthorIdent();
	commit.put("author", Map.of("time", formatDate(authorIdent.getWhenAsInstant(), authorIdent.getZoneId())));
	PersonIdent committerIdent = latestCommit.getCommitterIdent();
	commit.put("committer",
	Map.of("time", formatDate(committerIdent.getWhenAsInstant(), committerIdent.getZoneId())));
	Map<String, String> user = new LinkedHashMap<>();
	user.put("email", authorIdent.getEmailAddress());
	user.put("name", authorIdent.getName());
	commit.put("user", user);
	Map<String, Object> id = new LinkedHashMap<>();
	id.put("full", latestCommitId);
	id.put("abbrev", latestCommit.abbreviate(13).name());
	Map<String, String> message = new LinkedHashMap<>();
	message.put("full", latestCommit.getFullMessage().trim());
	message.put("short", latestCommit.getShortMessage().trim());
	id.put("message", message);
	commit.put("id", id);
	data.put("remote",
	GitUtil.sanitizeRemoteUrl(git.getRepository().getConfig().getString("remote", "origin", "url")));
	data.put("tags", getTags(git, latestCommit));
	}
	data.put("commit", commit);
	if (addFullInfo) {
	data.put("build", obtainBuildInfo(curateOutcomeBuildItem, repository));
	}
	valuesProducer.produce(new InfoBuildTimeValuesBuildItem("git", data));
	beanProducer.produce(SyntheticBeanBuildItem.configure(GitInfo.class)
	.supplier(recorder.gitInfoSupplier(branch, latestCommitId, latestCommitTime))
	.scope(ApplicationScoped.class)
	.setRuntimeInit()
	.done());
	} catch (Exception e) {
	log.debug("Unable to determine git information", e);
	}
	}

I would usually argue that configuration should not be used to expose such information, because there is nothing you are configuring here.

If you notice, we are producing an InfoBuildTimeValuesBuildItem with that info. How about if you consume that build item and produce a RunTimeConfigurationDefaultBuildItem, where you set quarkus.log.sentry.release with the commit id?

[geoand]

I agree with @radcortez here, but we are certainly open to listening to enhancement proposals