Add an integrationTest source set that can target a custom B2 endpoint

Offen
  • Stimmt etwas nicht?
#225 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 3 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, java
Bereich
build-system, testing

Rechercherichtung

Start with the test conventions in buildSrc/src/main/kotlin/b2sdk.gradle.kts and the credential handling in .github/workflows/ci_cd.yml. Then read B2ClientConfig.Builder.setMasterUrl and HttpClientFactoryImpl.Builder.setSupportInsecureHttp, and use samples/src/main/java/com/backblaze/b2/sample/B2Sample.java as the flow outline. Done means ./gradlew integrationTest skips cleanly without the env vars, runs against B2_ENDPOINT when set, and ./gradlew test is unchanged. Confirm with maintainers first, since the author has not pushed code and no reply exists yet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

What

Please consider adding a Gradle integrationTest source set whose tests run the main client flows against a configurable B2 endpoint, so the SDK has an integration suite that can run against either real B2 or a local B2 API simulator.

Why

The repository's tests run offline (stubbed web layer / local test server), and CI touches real B2 only to upload the build zip. There is therefore no suite that exercises the SDK end to end against a B2 API. A suite gated on an endpoint variable would let Backblaze's own CI or a contributor run it with no real-account credentials by pointing it at a local B2 API simulator. No SDK change is needed: the endpoint is already configurable.

What I checked (default branch master)

  • .github/workflows/ci_cd.yml:19-21 exposes B2_ACCOUNT_ID, B2_UPLOAD_BUCKET, B2_APPLICATION_KEY, used by the "Upload to b2" step (maybe_upload_build_results), which uploads the build zip; I found no test step that uses them.
  • The master URL is already configurable: B2ClientConfig.Builder.setMasterUrl (core/src/main/java/com/backblaze/b2/client/B2ClientConfig.java:113), consumed by B2StorageClientWebifierImpl (.../B2StorageClientWebifierImpl.java:106-123).
  • Plain-http loopback needs HttpClientFactoryImpl.Builder.setSupportInsecureHttp(true) (httpclient/src/main/java/com/backblaze/b2/client/webApiHttpClient/HttpClientFactoryImpl.java:128).
  • samples/src/main/java/com/backblaze/b2/sample/B2Sample.java already walks the main flows.
  • The test conventions live in buildSrc/src/main/kotlin/b2sdk.gradle.kts.

I did not read every test file line by line; I looked for integration-named files and for the CI credentials path, and found none.

Minimal sketch

  • New integrationTest source set (JUnit 4, same convention plugin), not part of the default test task.
  • Tests skip unless B2_ACCOUNT_ID, B2_APPLICATION_KEY and B2_ENDPOINT are set; B2_ENDPOINT goes to setMasterUrl.
  • Start from the B2Sample flows: authorize, create bucket, upload, list, download, large file, copy, hide, delete.

Acceptance criteria

  • ./gradlew test is unchanged and still offline.
  • ./gradlew integrationTest skips cleanly when the variables are unset, and runs against the given endpoint when set.
  • Nothing in the suite hard-codes api.backblazeb2.com.

Offer

The Backblaze SDK test-harness team can contribute the suite as a PR if that is welcome. We have not pushed any code.

🤖 Generated with Claude Code

Vorherrschende Sprache
Java
Sterne
103
Forks
23
Ø Merge
5 T. 8 Std.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Backblaze/b2-sdk-java

Alle Issues in Backblaze/b2-sdk-java

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.