From 7e8139965c55f1148ded2d96d1cfcd3c4e28644f Mon Sep 17 00:00:00 2001 From: jenkins Date: Sat, 14 Nov 2026 10:00:30 -0600 Subject: [PATCH] ci: select the requested source for queued Lesavka software runs --- services/jenkins/configmap-jcasc.yaml | 5 +- .../lesavka-source-selection.groovy | 131 ++++++++++++++++++ 2 files changed, 135 insertions(+), 1 deletion(-) create mode 100644 services/jenkins/validation/lesavka-source-selection.groovy diff --git a/services/jenkins/configmap-jcasc.yaml b/services/jenkins/configmap-jcasc.yaml index a24f7796..14035454 100644 --- a/services/jenkins/configmap-jcasc.yaml +++ b/services/jenkins/configmap-jcasc.yaml @@ -378,9 +378,12 @@ data: url('https://scm.bstein.dev/bstein/lesavka.git') credentials('gitea-pat') } - branches('*/dev-phone-companion-updates') + // Select both Jenkinsfile and worker source from the queued revision. + branches('$EXPECTED_SOURCE_REVISION') } } + // A commit is not a branch-head name for lightweight retrieval. + lightweight(false) scriptPath('docker/Jenkinsfile.software-tests') } } diff --git a/services/jenkins/validation/lesavka-source-selection.groovy b/services/jenkins/validation/lesavka-source-selection.groovy new file mode 100644 index 00000000..b4264f81 --- /dev/null +++ b/services/jenkins/validation/lesavka-source-selection.groovy @@ -0,0 +1,131 @@ +// Controller-side, read-only acceptance probe. Supply only the software job's +// reviewed Job DSL as candidateSeed in the binding. No jobs are saved or queued. +import groovy.json.JsonOutput +import groovy.xml.XmlUtil +import hudson.EnvVars +import hudson.FilePath +import hudson.model.TaskListener +import hudson.plugins.git.GitSCM +import hudson.plugins.git.util.BuildChooserContext +import hudson.plugins.git.util.BuildData +import javaposse.jobdsl.dsl.DslScriptLoader +import javaposse.jobdsl.dsl.Item +import javaposse.jobdsl.plugin.JenkinsJobManagement +import jenkins.model.Jenkins +import org.jenkinsci.plugins.gitclient.Git +import org.jenkinsci.plugins.gitclient.GitClient +import org.eclipse.jgit.storage.file.FileRepositoryBuilder +import java.nio.file.Files +import java.nio.file.attribute.PosixFilePermissions + +class ReviewOnly extends JenkinsJobManagement { + Map rendered = [:] + + ReviewOnly() { super(TaskListener.NULL.logger, [:], new File('/tmp')) } + + @Override boolean createOrUpdateConfig(Item item, boolean ignoreExisting) { + assert item.name == 'lesavka-software-tests' + rendered[item.name] = item.xml + return true + } + + @Override void queueJob(String name) { + throw new IllegalStateException('acceptance probe cannot queue jobs') + } +} + +def review = new ReviewOnly() +def installedState = { + def current = Jenkins.get().getItemByFullName('lesavka-software-tests').definition + [path: current.scriptPath, lightweight: current.lightweight, branches: current.scm.branches*.name] +} +def before = installedState() +new DslScriptLoader(review).runScript(binding.getVariable('candidateSeed')) +assert review.rendered.keySet() == ['lesavka-software-tests'] as Set +def xml = new XmlParser().parseText(review.rendered['lesavka-software-tests']) +def definition = Jenkins.XSTREAM2.fromXML(XmlUtil.serialize(xml.definition[0])) +assert !definition.lightweight +assert definition.scriptPath == 'docker/Jenkinsfile.software-tests' +def scm = definition.scm +assert scm.branches*.name == ['$EXPECTED_SOURCE_REVISION'] +assert scm.userRemoteConfigs.size() == 1 +assert scm.userRemoteConfigs[0].url == 'https://scm.bstein.dev/bstein/lesavka.git' +assert scm.userRemoteConfigs[0].credentialsId == 'gitea-pat' +assert xml.properties.'org.jenkinsci.plugins.workflow.job.properties.DisableConcurrentBuildsJobProperty'.size() == 1 +assert xml.properties.'jenkins.model.BuildDiscarderProperty'.strategy.numToKeep.text() == '8' +assert xml.properties.'jenkins.model.BuildDiscarderProperty'.strategy.artifactNumToKeep.text() == '4' + +def resolver = GitSCM.getDeclaredMethod('getSingleBranch', EnvVars) +resolver.accessible = true +def directory = Files.createTempDirectory('lesavka-source-selection-', + PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString('rwx------'))).toFile() +def checks = [] +try { + // Tiny public fixture only. No network, credentials, real repository or build. + def git = Git.with(TaskListener.NULL, new EnvVars()).in(directory).using('git').getClient() + git.init() + git.setAuthor('Lesavka CI fixture', 'fixture@example.invalid') + git.setCommitter('Lesavka CI fixture', 'fixture@example.invalid') + def pipeline = new File(directory, definition.scriptPath) + assert pipeline.parentFile.mkdirs() + def payload = new File(directory, 'source.txt') + pipeline.text = 'reviewed pipeline\n' + payload.text = 'reviewed source\n' + git.add('.') + git.commit('Reviewed fixture') + def requested = git.revParse('HEAD').name() + pipeline.text = 'later pipeline\n' + payload.text = 'later source\n' + git.add('.') + git.commit('Branch advanced while request waited') + def later = git.revParse('HEAD').name() + assert later != requested + def repository = new FileRepositoryBuilder().setGitDir(new File(directory, '.git')).build() + try { + def branch = repository.updateRef('refs/remotes/origin/dev-phone-companion-updates') + branch.setNewObjectId(git.revParse('HEAD')) + branch.forceUpdate() + } finally { + repository.close() + } + checks << 'branch_advanced_after_requested_revision' + + // Reproduce the old selector choosing the later branch tip in this fixture. + def oldScm = new GitSCM('https://example.invalid/review.git') + oldScm.branches = [new hudson.plugins.git.BranchSpec('*/dev-phone-companion-updates')] + def oldExpanded = resolver.invoke(oldScm, new EnvVars([EXPECTED_SOURCE_REVISION: requested])) + def oldCandidates = oldScm.buildChooser.getCandidateRevisions(false, oldExpanded, + (GitClient) git, TaskListener.NULL, new BuildData(), (BuildChooserContext) null) + assert oldCandidates.size() == 1 && oldCandidates.first().sha1String == later + checks << 'old_selector_reproduces_moving_branch_defect' + + // Exercise the installed plugin's expansion and actual revision chooser. + def expanded = resolver.invoke(scm, new EnvVars([EXPECTED_SOURCE_REVISION: requested])) + assert expanded == requested + def candidates = scm.buildChooser.getCandidateRevisions(false, expanded, (GitClient) git, + TaskListener.NULL, new BuildData(), (BuildChooserContext) null) + assert candidates.size() == 1 && candidates.first().sha1String == requested + git.checkout().ref(candidates.first().sha1String).execute() + assert git.revParse('HEAD').name() == requested + assert pipeline.text == 'reviewed pipeline\n' && payload.text == 'reviewed source\n' + checks << 'requested_pipeline_and_payload_selected_after_branch_advance' + + // A nonexistent full revision must not fall back to branch HEAD. + def missing = resolver.invoke(scm, new EnvVars([EXPECTED_SOURCE_REVISION: '0' * 40])) + assert scm.buildChooser.getCandidateRevisions(false, missing, (GitClient) git, + TaskListener.NULL, new BuildData(), (BuildChooserContext) null).isEmpty() + checks << 'missing_revision_does_not_select_head' + + // No real-job mutation: loading/parsing this configuration is not rollout. + assert installedState() == before + checks << 'installed_job_unchanged' +} finally { + new FilePath(directory).deleteRecursive() +} +assert !directory.exists() +checks << 'private_fixture_removed' +println(JsonOutput.toJson([status: 'passed', checks: checks, + plugins: ['git', 'git-client', 'workflow-cps', 'job-dsl'].collectEntries { + [(it): Jenkins.get().pluginManager.getPlugin(it).version] + }])) +return null