Skip to content

RTECO-945: Wire jf apk commands and e2e tests - #3561

Open
naveenku-jfrog wants to merge 5 commits into
masterfrom
RTECO-alpine
Open

RTECO-945: Wire jf apk commands and e2e tests#3561
naveenku-jfrog wants to merge 5 commits into
masterfrom
RTECO-alpine

Conversation

@naveenku-jfrog

@naveenku-jfrog naveenku-jfrog commented Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Wires the Alpine APK integration into the JFrog CLI frontend: registers jf apk subcommands, adds CLI flags, package aliasing (Ghost Frog), and a comprehensive e2e test suite. This is the user-facing entry point for the full Alpine APK feature.

Depends on:

What Changed

buildtools/cli.go

  • ApkCmd() — dispatches jf apk config, jf apk upload, and all native apk subcommands (add, upgrade, etc.)
  • Extracts JFrog-specific flags (--repo, --server-id, --alpine-version, --user, --password, --build-name, --build-number, --module, --project) before forwarding remaining args to native apk
  • Fail-fast on unknown --server-id: if --server-id is explicitly provided but not found in the config, the command errors immediately — consistent with jf npm, jf pip, jf mvn, etc.
  • Falls back to the default server silently when --server-id is omitted (allows jf apk add to work without Artifactory for basic usage)

utils/cliutils/commandsflags.go

  • New Apk flag group: --repo, --server-id, --alpine-version, --user, --password, --build-name, --build-number, --module, --project

docs/buildtools/apkcommand/help.go

  • GetDescription(), GetAIDescription(), Usage, GetArguments() for jf apk help text and AI help coverage

packagealias/packagealias.go

  • Registers apk as a Ghost Frog package alias so jf apk add curl works identically to jfrog apk add curl — consistent with npm, pip, mvn, etc.

apk_test.go

Full end-to-end test suite (35 test cases) covering:

Category Tests
Basic build-info NoBuildFlags, WithBuildFlags, BuildNameFromEnvVars
Dependency collection DepIDFormat, DepChecksums, DepRequestedBy, TransitiveDeps
Scopes ScopeProduction, ScopeTransitive
Repo / server config MissingRepo, InvalidRepo, UnknownServerID, ArtifactoryUnreachable, VirtualRepoAggregates
Upload Upload, UploadWithBuildInfo, CIVCSPropertiesStamped
Config Config, ConfigMissingServerID
Env vars EnvVarsFiltered, EnvVarsIncluded
Multi-package MultiPackageInstall, MultiPackageBuildInfo
Idempotency IdempotentAdd
Error handling ApkBinaryMissing

.github/workflows/apkTests.yml

CI workflow that runs all TestApk* tests against a matrix of Alpine versions (v3.18, v3.19, v3.20, v3.21):

  • Compiles the test binary on ubuntu-24.04 (where Go 1.26 is available)
  • Runs the pre-built static binary inside each alpine:<version> Docker container to get a real apk binary
  • Spins up a local Artifactory instance via install-local-artifactory
  • Triggered via workflow_call and workflow_dispatch

scripts/test-apk-local.sh

Helper script for running Alpine APK e2e tests locally on macOS via Docker (mounts the repo and ~/.jfrog config into a golang:alpine container).

Design Notes

--repo is optional: Consistent with jf npm install and jf pip install, omitting --repo does not block build-info collection. Checksums are always available from the APK database (C: field). AQL enrichment (for SHA-256/MD5) is skipped when no repo is specified.

Test infrastructure: Tests require the apk binary (Alpine Linux). The workflow compiles a static Linux binary on the host and runs it inside Alpine Docker containers, avoiding Go version constraints in Alpine package repos.

AI help coverage: jf apk is wired through corecommon.ResolveDescription to satisfy the TestAIHelpCoverageGenerated check.

@github-actions

github-actions Bot commented Jul 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@naveenku-jfrog naveenku-jfrog changed the title Rteco alpine RTECO-945: Wire jf apk commands and e2e tests Jul 14, 2026
@naveenku-jfrog naveenku-jfrog mentioned this pull request Jul 17, 2026
Open
4 tasks
@naveenku-jfrog @cursoragent
RTECO-945: Add jf apk commands, e2e tests, and Alpine CI
3cfc0ed 
- Wire jf apk add/upgrade/upload/update and jf setup apk into the CLI
- Add Alpine APK e2e tests: build-info, release-bundle creation,
  build-promote, arch auto-detect from .PKGINFO, indexable-path layout
- Add selective-retry e2e runner script and apk-tools v2/v3 CI matrix
- Bump build-info-go, jfrog-cli-core, jfrog-cli-artifactory to Alpine builds

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

👍 Frogbot scanned this pull request and did not find any new security issues.

@naveenku-jfrog
RTECO-945: Update Alpine repository validation
10f5348 
Consume the Artifactory implementation that validates explicit APK repository selections before execution.
agrasth
agrasth reviewed Jul 27, 2026
View reviewed changes
Comment thread buildtools/cli.go Outdated
Comment thread buildtools/cli.go Outdated
Comment thread .github/workflows/apkTests.yml
$creds 2>&1 | tee /tmp/apk-out.log

# Collect the top-level names of tests that failed this attempt.
fails=$(grep -Eo '^--- FAIL: [A-Za-z0-9_]+' /tmp/apk-out.log | awk '{print $3}' | sort -u | tr '\n' '|' | sed 's/|$//')

@agrasth agrasth Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only checks for literal --- FAIL: lines in the captured output — it doesn't check docker run's own exit code. If the test binary crashes/panics or the container gets OOM-killed before printing any --- FAIL: line, $fails stays empty and the step reports "All Alpine tests passed" on that attempt. Might be worth capturing ${PIPESTATUS[0]} (or splitting the pipe) and treating a non-zero docker exit as a failure too.

Comment thread apk_test.go

// TestApkAdd_ArtifactoryUnreachable verifies that when Artifactory is unreachable
// jf apk add returns a clear error and does not silently fall back to the public CDN.
func TestApkAdd_ArtifactoryUnreachable(t *testing.T) {

@agrasth agrasth Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test body is identical to TestApkAdd_UnknownServerID above (same --server-id=nonexistent-server-id-xyz args) — it doesn't actually simulate an unreachable Artifactory server, it just re-tests the unknown-server-id path. Should this point at a real unreachable host/port instead (e.g. an invalid URL in a throwaway server config) to cover the case the name describes?

Comment thread apk_test.go Outdated
Comment thread apk_test.go
}
}
}
assert.True(t, hasProd, "at least one dependency should have scope 'prod'")

@agrasth agrasth Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hasTransitive is computed but only logged at line 468-469, never asserted. Given the comment above says curl reliably brings in transitive deps (libcurl, musl, etc.), should this be assert.True(t, hasTransitive, ...) like the hasProd check right above it, rather than just a log line?

Comment thread apk_test.go Outdated
Comment thread docs/buildtools/apkcommand/help.go Outdated
Comment thread utils/cliutils/commandsflags.go Outdated
naveenku-jfrog and others added 3 commits July 29, 2026 09:34
@naveenku-jfrog
Merge branch 'master' into RTECO-alpine
e4e5858
@naveenku-jfrog @cursoragent
RTECO-945: Address review comments for jf apk
ec1295f 
- Intercept `help`/`-h` so `jf apk help` and `jf apk upload -h` print CLI
  help and exit 0 instead of forwarding to native apk
- Resolve server details via resolveApkServerDetails with
  excludeRefreshableTokens so persistent apk config avoids short-lived
  tokens; guard SetServerDetails against a nil server
- Document build-info vs passthrough subcommands and per-subcommand
  flags; make --branch apk-specific
- Harden the Alpine CI retry loop against container-level failures

Co-authored-by: Cursor <cursoragent@cursor.com>
@naveenku-jfrog @cursoragent
Merge branch 'master' into RTECO-alpine
d20ee43 
Resolve conflicts:
- buildtools/cli.go: keep the alpine command import alongside conan/nix
- go.mod/go.sum: keep the Alpine build-info-go (c384608) required by the
  alpine cli-core/artifactory/client versions; take master froggit-go v1.23.1

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agrasth agrasth agrasth left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@naveenku-jfrog @agrasth