Skip to content

Commit 8618c2a

Browse files
trgandaclaude
trganda
and
claude
committed
feat: auto-resolve latest CodeQL versions from GitHub API in set-version command
Add GitHubReleaseResolver that queries the GitHub Releases API to fetch the latest tag from github/codeql-cli-binaries and github/codeql-action, using them as default values for --cli-version, --standard-library-version, and --bundle-version on 'qlt codeql set version'. Falls back to hardcoded values (2.25.1) if the network request fails. Add InternalsVisibleTo for the test project and 14 unit tests covering successful resolution, network errors, malformed JSON, missing tag_name, and fallback value format sanity checks. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d238d3d commit 8618c2a

File tree

4 files changed

+261
-3
lines changed

4 files changed

+261
-3
lines changed

‎src/CodeQLToolkit.Features/CodeQL/Lifecycle/CodeQLLifecycleFeature.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using CodeQLToolkit.Features.CodeQL.Lifecycle.Targets;
2+
using CodeQLToolkit.Shared.CodeQL;
23
using System.CommandLine;
34

45
namespace CodeQLToolkit.Features.CodeQL.Lifecycle
@@ -19,9 +20,9 @@ public void Register(Command parentCommand)
1920

2021
var setVersionCommand = new Command("version", "Sets the version of CodeQL used.");
2122

22-
var cliVersionOption = new Option<string>("--cli-version", () => "2.11.6", "The version of the cli to use. Example: `2.11.6`.") { IsRequired = true };
23-
var standardLibraryVersionOption = new Option<string>("--standard-library-version", () => "codeql-cli/v2.11.6", "The version of the standard library to use. Example: `codeql-cli/v2.11.6`.") { IsRequired = true };
24-
var bundleVersionOption = new Option<string>("--bundle-version", () => "codeql-bundle-20221211", "The bundle version to use. Example: `codeql-bundle-20221211`.") { IsRequired = true };
23+
var cliVersionOption = new Option<string>("--cli-version", GitHubReleaseResolver.GetLatestCLIVersion, "The version of the cli to use. Example: `2.25.1`.") { IsRequired = true };
24+
var standardLibraryVersionOption = new Option<string>("--standard-library-version", GitHubReleaseResolver.GetLatestStandardLibraryVersion, "The version of the standard library to use. Example: `codeql-cli/v2.25.1`.") { IsRequired = true };
25+
var bundleVersionOption = new Option<string>("--bundle-version", GitHubReleaseResolver.GetLatestBundleVersion, "The bundle version to use. Example: `codeql-bundle-v2.25.1`.") { IsRequired = true };
2526

2627
setVersionCommand.Add(cliVersionOption);
2728
setVersionCommand.Add(standardLibraryVersionOption);

‎src/CodeQLToolkit.Shared/CodeQL/GitHubReleaseResolver.cs‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
using Newtonsoft.Json.Linq;
2+
using System.Net.Http.Headers;
3+
4+
namespace CodeQLToolkit.Shared.CodeQL
5+
{
6+
/// <summary>
7+
/// Resolves the latest release versions for CodeQL CLI, standard library, and bundle
8+
/// from GitHub's public API. Falls back to hardcoded values if the request fails.
9+
/// </summary>
10+
public static class GitHubReleaseResolver
11+
{
12+
public const string FallbackCLIVersion = "2.25.1";
13+
public const string FallbackStandardLibraryVersion = "codeql-cli/v2.25.1";
14+
public const string FallbackBundleVersion = "codeql-bundle-v2.25.1";
15+
16+
private static readonly HttpClient _client = CreateClient(null);
17+
18+
private static HttpClient CreateClient(HttpMessageHandler? handler)
19+
{
20+
var client = handler != null ? new HttpClient(handler) : new HttpClient();
21+
client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue("qlt", "1.0"));
22+
client.Timeout = TimeSpan.FromSeconds(5);
23+
return client;
24+
}
25+
26+
/// <summary>
27+
/// Fetches the latest CodeQL CLI version string (e.g. "2.25.1").
28+
/// Falls back to <see cref="FallbackCLIVersion"/> on any error.
29+
/// </summary>
30+
public static string GetLatestCLIVersion() => GetLatestCLIVersion(_client);
31+
32+
/// <summary>
33+
/// Fetches the latest standard library version string (e.g. "codeql-cli/v2.25.1").
34+
/// Falls back to <see cref="FallbackStandardLibraryVersion"/> on any error.
35+
/// </summary>
36+
public static string GetLatestStandardLibraryVersion() => GetLatestStandardLibraryVersion(_client);
37+
38+
/// <summary>
39+
/// Fetches the latest bundle version string (e.g. "codeql-bundle-v2.25.1").
40+
/// Falls back to <see cref="FallbackBundleVersion"/> on any error.
41+
/// </summary>
42+
public static string GetLatestBundleVersion() => GetLatestBundleVersion(_client);
43+
44+
// Internal overloads for testing — accept a custom HttpClient.
45+
46+
internal static string GetLatestCLIVersion(HttpClient client)
47+
{
48+
try
49+
{
50+
var tag = GetLatestTagName(client, "https://api.github.com/repos/github/codeql-cli-binaries/releases/latest");
51+
return tag.TrimStart('v');
52+
}
53+
catch
54+
{
55+
return FallbackCLIVersion;
56+
}
57+
}
58+
59+
internal static string GetLatestStandardLibraryVersion(HttpClient client)
60+
{
61+
try
62+
{
63+
var tag = GetLatestTagName(client, "https://api.github.com/repos/github/codeql-cli-binaries/releases/latest");
64+
return $"codeql-cli/v{tag.TrimStart('v')}";
65+
}
66+
catch
67+
{
68+
return FallbackStandardLibraryVersion;
69+
}
70+
}
71+
72+
internal static string GetLatestBundleVersion(HttpClient client)
73+
{
74+
try
75+
{
76+
// codeql-action release tags are already in the form "codeql-bundle-vX.Y.Z"
77+
return GetLatestTagName(client, "https://api.github.com/repos/github/codeql-action/releases/latest");
78+
}
79+
catch
80+
{
81+
return FallbackBundleVersion;
82+
}
83+
}
84+
85+
internal static HttpClient CreateTestClient(HttpMessageHandler handler) => CreateClient(handler);
86+
87+
private static string GetLatestTagName(HttpClient client, string url)
88+
{
89+
var response = client.GetAsync(url).GetAwaiter().GetResult();
90+
response.EnsureSuccessStatusCode();
91+
var json = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
92+
var obj = JObject.Parse(json);
93+
return obj["tag_name"]!.Value<string>()!;
94+
}
95+
}
96+
}

‎src/CodeQLToolkit.Shared/CodeQLToolkit.Shared.csproj‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
<Nullable>enable</Nullable>
77
</PropertyGroup>
88

9+
<ItemGroup>
10+
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
11+
<_Parameter1>CodeQLToolkit.Shared.Tests</_Parameter1>
12+
</AssemblyAttribute>
13+
</ItemGroup>
14+
915
<ItemGroup>
1016
<PackageReference Include="LibGit2Sharp" Version="0.29.0" />
1117
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />

‎test/CodeQLToolkit.Shared.Tests/CodeQL/GitHubReleaseResolverTests.cs‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
using CodeQLToolkit.Shared.CodeQL;
2+
using System.Net;
3+
using System.Text;
4+
5+
namespace CodeQLToolkit.Shared.Tests.CodeQL
6+
{
7+
public class GitHubReleaseResolverTests
8+
{
9+
// Fake HttpMessageHandler that returns a fixed response.
10+
private class StubHandler : HttpMessageHandler
11+
{
12+
private readonly HttpStatusCode _statusCode;
13+
private readonly string _body;
14+
15+
public StubHandler(HttpStatusCode statusCode, string body)
16+
{
17+
_statusCode = statusCode;
18+
_body = body;
19+
}
20+
21+
protected override Task<HttpResponseMessage> SendAsync(
22+
HttpRequestMessage request, CancellationToken cancellationToken)
23+
{
24+
var response = new HttpResponseMessage(_statusCode)
25+
{
26+
Content = new StringContent(_body, Encoding.UTF8, "application/json")
27+
};
28+
return Task.FromResult(response);
29+
}
30+
}
31+
32+
private static HttpClient MakeClient(HttpStatusCode status, string body)
33+
=> GitHubReleaseResolver.CreateTestClient(new StubHandler(status, body));
34+
35+
private const string CliResponse = "{\"tag_name\":\"v2.99.0\",\"name\":\"v2.99.0\"}";
36+
private const string BundleResponse = "{\"tag_name\":\"codeql-bundle-v3.28.5\",\"name\":\"codeql-bundle-v3.28.5\"}";
37+
38+
// ── GetLatestCLIVersion ──────────────────────────────────────────────
39+
40+
[Test]
41+
public void GetLatestCLIVersion_ParsesTagAndStripsV()
42+
{
43+
var client = MakeClient(HttpStatusCode.OK, CliResponse);
44+
var result = GitHubReleaseResolver.GetLatestCLIVersion(client);
45+
Assert.That(result, Is.EqualTo("2.99.0"));
46+
}
47+
48+
[Test]
49+
public void GetLatestCLIVersion_ReturnsFallback_OnNetworkError()
50+
{
51+
var client = MakeClient(HttpStatusCode.ServiceUnavailable, "");
52+
var result = GitHubReleaseResolver.GetLatestCLIVersion(client);
53+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackCLIVersion));
54+
}
55+
56+
[Test]
57+
public void GetLatestCLIVersion_ReturnsFallback_OnMalformedJson()
58+
{
59+
var client = MakeClient(HttpStatusCode.OK, "not-json");
60+
var result = GitHubReleaseResolver.GetLatestCLIVersion(client);
61+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackCLIVersion));
62+
}
63+
64+
[Test]
65+
public void GetLatestCLIVersion_ReturnsFallback_OnMissingTagName()
66+
{
67+
var client = MakeClient(HttpStatusCode.OK, "{\"name\":\"v2.99.0\"}");
68+
var result = GitHubReleaseResolver.GetLatestCLIVersion(client);
69+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackCLIVersion));
70+
}
71+
72+
// ── GetLatestStandardLibraryVersion ─────────────────────────────────
73+
74+
[Test]
75+
public void GetLatestStandardLibraryVersion_FormatsCorrectly()
76+
{
77+
var client = MakeClient(HttpStatusCode.OK, CliResponse);
78+
var result = GitHubReleaseResolver.GetLatestStandardLibraryVersion(client);
79+
Assert.That(result, Is.EqualTo("codeql-cli/v2.99.0"));
80+
}
81+
82+
[Test]
83+
public void GetLatestStandardLibraryVersion_ReturnsFallback_OnNetworkError()
84+
{
85+
var client = MakeClient(HttpStatusCode.InternalServerError, "");
86+
var result = GitHubReleaseResolver.GetLatestStandardLibraryVersion(client);
87+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackStandardLibraryVersion));
88+
}
89+
90+
[Test]
91+
public void GetLatestStandardLibraryVersion_ReturnsFallback_OnMalformedJson()
92+
{
93+
var client = MakeClient(HttpStatusCode.OK, "not-json");
94+
var result = GitHubReleaseResolver.GetLatestStandardLibraryVersion(client);
95+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackStandardLibraryVersion));
96+
}
97+
98+
// ── GetLatestBundleVersion ───────────────────────────────────────────
99+
100+
[Test]
101+
public void GetLatestBundleVersion_FormatsCorrectly()
102+
{
103+
var client = MakeClient(HttpStatusCode.OK, BundleResponse);
104+
var result = GitHubReleaseResolver.GetLatestBundleVersion(client);
105+
Assert.That(result, Is.EqualTo("codeql-bundle-v3.28.5"));
106+
}
107+
108+
[Test]
109+
public void GetLatestBundleVersion_ReturnsFallback_OnNetworkError()
110+
{
111+
var client = MakeClient(HttpStatusCode.ServiceUnavailable, "");
112+
var result = GitHubReleaseResolver.GetLatestBundleVersion(client);
113+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackBundleVersion));
114+
}
115+
116+
[Test]
117+
public void GetLatestBundleVersion_ReturnsFallback_OnMalformedJson()
118+
{
119+
var client = MakeClient(HttpStatusCode.OK, "not-json");
120+
var result = GitHubReleaseResolver.GetLatestBundleVersion(client);
121+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackBundleVersion));
122+
}
123+
124+
[Test]
125+
public void GetLatestBundleVersion_ReturnsFallback_OnMissingTagName()
126+
{
127+
var client = MakeClient(HttpStatusCode.OK, "{\"name\":\"codeql-bundle-v3.28.5\"}");
128+
var result = GitHubReleaseResolver.GetLatestBundleVersion(client);
129+
Assert.That(result, Is.EqualTo(GitHubReleaseResolver.FallbackBundleVersion));
130+
}
131+
132+
// ── Fallback value format sanity checks ──────────────────────────────
133+
134+
[Test]
135+
public void FallbackCLIVersion_HasCorrectFormat()
136+
{
137+
// Should be X.Y.Z with no leading 'v'
138+
var parts = GitHubReleaseResolver.FallbackCLIVersion.Split('.');
139+
Assert.That(parts.Length, Is.EqualTo(3));
140+
Assert.That(GitHubReleaseResolver.FallbackCLIVersion, Does.Not.StartWith("v"));
141+
}
142+
143+
[Test]
144+
public void FallbackStandardLibraryVersion_HasCorrectFormat()
145+
{
146+
Assert.That(GitHubReleaseResolver.FallbackStandardLibraryVersion, Does.StartWith("codeql-cli/v"));
147+
}
148+
149+
[Test]
150+
public void FallbackBundleVersion_HasCorrectFormat()
151+
{
152+
Assert.That(GitHubReleaseResolver.FallbackBundleVersion, Does.StartWith("codeql-bundle-v"));
153+
}
154+
}
155+
}

0 commit comments

Comments
 (0)