This commit is contained in:
envolution 2025-02-17 16:11:03 +01:00 committed by GitHub
commit b326eeec81
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 562 additions and 0 deletions

307
graphql.output.json Normal file
View file

@ -0,0 +1,307 @@
{
"data": {
"rateLimit": {
"limit": 5000,
"remaining": 4988,
"resetAt": "2024-11-20T05:34:23Z"
},
"repository": {
"defaultBranchRef": {
"target": {
"history": {
"totalCount": 4640,
"edges": [
{
"node": {
"oid": "65c463fcbf3b75eb60c9d51d4cf04abbfe736b98",
"committedDate": "2024-11-19T19:49:27Z"
}
}
]
}
}
},
"refs": {
"edges": [
{
"node": {
"name": "v3.0.9",
"target": {
"oid": "72c8f30c17e03b01711b902525250e48594350aa"
}
}
}
]
},
"releases": {
"totalCount": 26,
"edges": [
{
"node": {
"name": "Version 3.0.9",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.0.9",
"tagName": "v3.0.9",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2024-06-13T16:56:28Z"
}
},
{
"node": {
"name": "Release version 3.2rc3",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.2rc3",
"tagName": "v3.2rc3",
"isPrerelease": false,
"isLatest": true,
"createdAt": "2023-10-10T10:22:24Z"
}
},
{
"node": {
"name": "Version 3.0.8",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.0.8",
"tagName": "v3.0.8",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2022-09-28T19:05:06Z"
}
},
{
"node": {
"name": "Version 3.0.7",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.0.7",
"tagName": "v3.0.7",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2022-02-19T13:42:25Z"
}
},
{
"node": {
"name": "Version 3.0",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.0",
"tagName": "v3.0",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2021-10-03T09:05:27Z"
}
},
{
"node": {
"name": "Version 3.0.6",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v3.0.6",
"tagName": "v3.0.6",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2021-10-03T09:00:16Z"
}
},
{
"node": {
"name": "Version 3.0.5",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0.5",
"tagName": "3.0.5",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2021-05-10T11:50:07Z"
}
},
{
"node": {
"name": "Version 3.0.4",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0.4",
"tagName": "3.0.4",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2020-11-20T16:59:15Z"
}
},
{
"node": {
"name": "Version 3.0.3",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0.3",
"tagName": "3.0.3",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2020-11-19T08:43:35Z"
}
},
{
"node": {
"name": "Version 3.0.2",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0.2",
"tagName": "3.0.2",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2020-05-08T09:56:50Z"
}
},
{
"node": {
"name": "Version 3.0.1",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0.1",
"tagName": "3.0.1",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2020-04-15T10:37:32Z"
}
},
{
"node": {
"name": "Version 3.0-1",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0-1",
"tagName": "3.0-1",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2020-04-15T07:34:31Z"
}
},
{
"node": {
"name": "Version 3.0 rc6",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc6",
"tagName": "3.0rc6",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2019-12-11T20:54:31Z"
}
},
{
"node": {
"name": "Version 3.0 rc5",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc5",
"tagName": "3.0rc5",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2019-04-25T07:21:23Z"
}
},
{
"node": {
"name": "Version 2.9.5-8",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-8",
"tagName": "v2.9.5-8",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2019-04-23T20:27:29Z"
}
},
{
"node": {
"name": "Version 3.0 rc4",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc4",
"tagName": "3.0rc4",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2019-02-18T19:33:08Z"
}
},
{
"node": {
"name": "Version 3.0 rc3",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc3",
"tagName": "3.0rc3",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-11-30T17:38:31Z"
}
},
{
"node": {
"name": "Version 3.0 rc2",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc2",
"tagName": "3.0rc2",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-10-09T10:36:15Z"
}
},
{
"node": {
"name": "Version 2.9.5-7",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-7",
"tagName": "v2.9.5-7",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-09-07T15:05:41Z"
}
},
{
"node": {
"name": "Version 3.0 rc1",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/3.0rc1",
"tagName": "3.0rc1",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-09-06T06:19:17Z"
}
},
{
"node": {
"name": "Version 2.9.5-5",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-5",
"tagName": "v2.9.5-5",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-04-09T08:07:46Z"
}
},
{
"node": {
"name": "Version 2.9.5-3",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-3",
"tagName": "v2.9.5-3",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-03-24T18:45:21Z"
}
},
{
"node": {
"name": "Version 2.9.5-2",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-2",
"tagName": "v2.9.5-2",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2018-02-19T10:16:04Z"
}
},
{
"node": {
"name": "Version 2.9.5-1",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.9.5-1",
"tagName": "v2.9.5-1",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2017-09-20T15:24:37Z"
}
},
{
"node": {
"name": "Version 2.8",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.8",
"tagName": "v2.8",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2017-05-10T19:04:48Z"
}
},
{
"node": {
"name": "Version 2.6",
"url": "https://github.com/drwetter/testssl.sh/releases/tag/v2.6",
"tagName": "v2.6",
"isPrerelease": false,
"isLatest": false,
"createdAt": "2015-09-25T18:56:09Z"
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "Y3Vyc29yOnYyOpK5MjAxNS0wOS0yNVQxNDo1NjowOS0wNDowMM4AHJKe"
}
}
}
}
}

View file

@ -0,0 +1,55 @@
# Extract important variables from the GitHub GraphQL JSON response
data = j["data"]
# Rate limit information
rate_limit = {
"max_requests": data["rateLimit"]["limit"], # Maximum allowed requests
"remaining_requests": data["rateLimit"]["remaining"], # Remaining requests in the current window
"reset_time": data["rateLimit"]["resetAt"], # Time when the rate limit resets
}
# Repository information
repository = data["repository"]
# Default branch commit history
default_branch_commit = {
"total_commits": repository["defaultBranchRef"]["target"]["history"]["totalCount"], # Total number of commits
"latest_commit_oid": repository["defaultBranchRef"]["target"]["history"]["edges"][0]["node"]["oid"], # Latest commit hash (OID)
"latest_commit_date": repository["defaultBranchRef"]["target"]["history"]["edges"][0]["node"]["committedDate"], # Latest commit date
}
# Tags information
tags = [
edge["node"]["name"] for edge in repository["refs"]["edges"]
] # List of tag names (if available)
# Releases information
releases = [
{
"name": release["node"]["name"], # Release name
"url": release["node"]["url"], # Release URL
"tag": release["node"]["tagName"], # Tag associated with the release
"is_prerelease": release["node"]["isPrerelease"], # Whether this is a pre-release
"is_latest": release["node"]["isLatest"], # Whether this is the latest release
"created_at": release["node"]["createdAt"], # Release creation date
}
for release in repository["releases"]["edges"]
]
# Pagination info for releases
releases_pagination = {
"has_next_page": repository["releases"]["pageInfo"]["hasNextPage"], # Whether there are more releases
"end_cursor": repository["releases"]["pageInfo"]["endCursor"], # Cursor for the next page of releases
}
# Organized result as a dictionary
result = {
"rate_limit": rate_limit,
"default_branch_commit": default_branch_commit,
"tags": tags,
"releases": releases,
"releases_pagination": releases_pagination,
}
# Example of accessing the organized data
print(result)

View file

@ -0,0 +1,182 @@
# MIT licensed
# Copyright (c) 2013-2020, 2024 lilydjwg <lilydjwg@gmail.com>, et al.
import os
import time
import aiohttp
from typing import List, Tuple, Union, Optional
from nvchecker.api import RichResult, Entry, KeyManager, GetVersionError, AsyncCache
async def get_github_token(conf: Entry, host: str, keymanager: KeyManager) -> Optional[str]:
token = conf.get('token')
if token is None:
token = keymanager.get_key(host.lower(), 'github')
#if token is None:
# token = os.environ.get('GITHUB_TOKEN')
return token
def create_rich_result(conf, commits, sha, **kwargs) -> RichResult:
if conf.get('use_commit_number', False):
kwargs['version'] += f"+r{str(commits)}"
if conf.get('use_commit_hash', False):
kwargs['version'] += f"+g{sha[:9]}"
return RichResult(**kwargs)
async def get_version(
name: str, conf: Entry, *,
cache: AsyncCache, keymanager: KeyManager,
**kwargs,
) -> RichResult:
repo = conf['github']
owner, reponame = repo.split('/')
host = conf.get('host', "github.com")
token = await get_github_token(conf, host, keymanager)
if not token:
raise GetVersionError('token not given but it is required')
GITHUB_GRAPHQL_URL = 'https://api.github.com/graphql'
query = """
query {
repository(owner: "$owner", name: "$name") {
defaultBranchRef {
target {
... on Commit {
history(first: 1) {
totalCount
edges {
node {
oid
committedDate
}
}
}
}
}
}
refs(refPrefix: "refs/tags/", first: 100, orderBy: {field: TAG_COMMIT_DATE, direction: DESC}) {
edges {
node {
name
target {
oid
}
}
}
}
releases(first: 100, orderBy: { field: CREATED_AT, direction: DESC }) {
edges {
node {
name
url
tagName
isPrerelease
isLatest
createdAt
}
}
}
}
}
"""
query_vars = query.replace("$owner", owner).replace("$name", reponame)
async with aiohttp.ClientSession() as session:
headers = {
'Authorization': f'bearer {token}',
'Content-Type': 'application/json',
}
try:
async with session.post(
GITHUB_GRAPHQL_URL,
headers=headers,
json={'query': query_vars}
) as response:
data = await response.json()
if 'errors' in data:
raise GetVersionError(f"GitHub API error: {data['errors']}")
repo_data = data['data']['repository']
commits = repo_data["defaultBranchRef"]["target"]["history"]["totalCount"]
sha = repo_data["defaultBranchRef"]["target"]["history"]["edges"][0]["node"]["oid"]
# Latest Tag Strategy
if conf.get('use_latest_tag', False):
refs = repo_data['refs']['edges']
if not refs:
raise GetVersionError('No tag found in upstream repository.')
latest_tag = refs[0]['node']
return create_rich_result(
conf=conf,
commits=commits,
sha=sha,
version=latest_tag['name'],
gitref=f"refs/tags/{latest_tag['name']}",
revision=latest_tag['target']['oid'],
url=f'https://github.com/{repo}/releases/tag/{latest_tag["name"]}'
)
# Maximum Tag Strategy - Return first tag
if conf.get('use_max_tag', False):
refs = repo_data['refs']['edges']
if not refs:
raise GetVersionError('No tag found in upstream repository.')
first_tag = refs[0]['node']
return create_rich_result(
conf=conf,
commits=commits,
sha=sha,
version=first_tag['name'],
gitref=f"refs/tags/{first_tag['name']}",
revision=first_tag['target']['oid'],
url=f'https://github.com/{repo}/releases/tag/{first_tag["name"]}'
)
# Release Strategies
if conf.get('use_latest_release', False) or conf.get('use_newest_release', False):
releases = repo_data['releases']['edges']
if not releases:
raise GetVersionError('No release found in upstream repository.')
include_prereleases = conf.get('use_prereleases', False)
if conf.get('use_latest_release', False):
latest_release = next(
(release['node'] for release in releases
if release['node']['isLatest'] or (include_prereleases and release['node']['isPrerelease'])),
None
)
else:
latest_release = releases[0]['node']
if not latest_release:
raise GetVersionError('No suitable release found')
use_release_name = conf.get('use_release_name', False)
version = latest_release['name'] if use_release_name else latest_release['tagName']
return create_rich_result(
conf=conf,
commits=commits,
sha=sha,
version=version,
gitref=f"refs/tags/{latest_release['tagName']}",
url=latest_release['url']
)
# Default: Use commit date
commit = repo_data['defaultBranchRef']['target']['history']['edges'][0]['node']
return create_rich_result(
conf=conf,
commits=commits,
sha=sha,
version=commit['committedDate'].rstrip('Z').replace('-', '').replace(':', '').replace('T', '.'),
revision=commit['oid'],
url=f'https://github.com/{repo}/commit/{commit["oid"]}'
)
except aiohttp.ClientError as e:
raise GetVersionError(f"GitHub API request failed: {e}")

View file

@ -0,0 +1,18 @@
["testssl.sh-git"]
source="github-test"
github="drwetter/testssl.sh"
#use_max_tag=true
#use_latest_tag=true
#uses latest release marked as Latest by github, this is not always the newest (evidenced by the repo in this file)
#use_latest_release=true
#include_prereleases=true
#selects the most recent by ordered list descending
use_newest_release=true
#use_release_name=true
#i find these useful to match arch guidelines for VCS packages
use_commit_number=true
use_commit_hash=true