Skip to content

test: add unit coverage for ci writer helpers#3569

Open
Ankitsinghsisodya wants to merge 2 commits intoknative:mainfrom
Ankitsinghsisodya:test/ci-writer-helpers
Open

test: add unit coverage for ci writer helpers#3569
Ankitsinghsisodya wants to merge 2 commits intoknative:mainfrom
Ankitsinghsisodya:test/ci-writer-helpers

Conversation

@Ankitsinghsisodya
Copy link
Copy Markdown
Contributor

@Ankitsinghsisodya Ankitsinghsisodya commented Apr 1, 2026

test: add unit tests for BufferWriter in cmd/ci

Closes #3567

Matches the draft in pr1/issue.md.

What this PR does

Adds cmd/ci/writer_test.go — a new test file for cmd/ci/writer.go.

Before this change, the BufferWriter test double had zero direct test
coverage
. This PR adds focused tests for the behaviours other cmd/ci tests
depend on: recording the path passed to Write, reporting existence based on
buffer content, and resetting the buffer on consecutive writes.

Changes

File Change
cmd/ci/writer_test.go New — 3 test functions for BufferWriter

Tests added

TestBufferWriter_WriteAndExist   // Exist is false before Write and true after Write
TestBufferWriter_Write_StoresPath // Write records the provided path
TestBufferWriter_Write_ResetsBuffer // consecutive writes replace content

How to verify

go test ./cmd/ci/... -v -run TestBufferWriter

Expected output: 3 tests PASS, ok knative.dev/func/cmd/ci.

Checklist

  • Tests only — no production code changed
  • make test passes
  • make check passes
  • No new dependencies introduced

Add tests for the fileWriter (DefaultWorkflowWriter) and BufferWriter
implementations in cmd/ci/writer.go.

Covered:
- Write creates all missing parent directories
- Write overwrites existing file content (no append)
- Exist returns false before any write
- Exist returns true after a successful write
- BufferWriter.Write stores path and resets buffer on each call
- BufferWriter.Exist reflects buffer non-emptiness

Fixes zero-coverage on writer.go:26 and writer.go:38.
Copilot AI review requested due to automatic review settings April 1, 2026 19:09
@knative-prow knative-prow bot requested review from dsimansk and jrangelramos April 1, 2026 19:09
@knative-prow
Copy link
Copy Markdown

knative-prow bot commented Apr 1, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Ankitsinghsisodya
Once this PR has been reviewed and has the lgtm label, please assign dsimansk for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot added size/M 🤖 PR changes 30-99 lines, ignoring generated files. needs-ok-to-test 🤖 Needs an org member to approve testing labels Apr 1, 2026
@knative-prow
Copy link
Copy Markdown

knative-prow bot commented Apr 1, 2026

Hi @Ankitsinghsisodya. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds unit tests for the CI workflow writer helpers in cmd/ci/writer.go, addressing the lack of coverage noted in #3567.

Changes:

  • Introduces cmd/ci/writer_test.go with unit tests covering fileWriter.Write, fileWriter.Exist, and the BufferWriter test double.
  • Verifies parent directory creation, overwrite (truncate) behavior, and in-memory writer semantics (path recording + buffer reset).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.24%. Comparing base (e92b074) to head (d5e6ba7).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3569      +/-   ##
==========================================
+ Coverage   55.52%   56.24%   +0.72%     
==========================================
  Files         180      180              
  Lines       20465    20465              
==========================================
+ Hits        11363    11511     +148     
+ Misses       7902     7755     -147     
+ Partials     1200     1199       -1     
Flag Coverage Δ
e2e 36.10% <ø> (-4.07%) ⬇️
e2e go 32.55% <ø> (ø)
e2e node 28.36% <ø> (ø)
e2e python 32.91% <ø> (ø)
e2e quarkus 28.50% <ø> (+0.02%) ⬆️
e2e rust 27.92% <ø> (ø)
e2e springboot 26.34% <ø> (-0.03%) ⬇️
e2e typescript 28.47% <ø> (ø)
e2e-config-ci 18.14% <ø> (ø)
integration 17.40% <ø> (+<0.01%) ⬆️
unit macos-14 43.37% <ø> (ø)
unit macos-latest 43.37% <ø> (ø)
unit ubuntu-24.04-arm 43.57% <ø> (ø)
unit ubuntu-latest 44.25% <ø> (ø)
unit windows-latest 43.38% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Ankitsinghsisodya Ankitsinghsisodya marked this pull request as draft April 1, 2026 19:29
@knative-prow knative-prow bot added the do-not-merge/work-in-progress 🤖 PR should not merge because it is a work in progress. label Apr 1, 2026
@Ankitsinghsisodya Ankitsinghsisodya marked this pull request as ready for review April 1, 2026 21:10
@knative-prow knative-prow bot removed the do-not-merge/work-in-progress 🤖 PR should not merge because it is a work in progress. label Apr 1, 2026
@Ankitsinghsisodya Ankitsinghsisodya marked this pull request as draft April 1, 2026 21:52
@knative-prow knative-prow bot added the do-not-merge/work-in-progress 🤖 PR should not merge because it is a work in progress. label Apr 1, 2026
@Ankitsinghsisodya Ankitsinghsisodya marked this pull request as ready for review April 1, 2026 22:58
@knative-prow knative-prow bot removed the do-not-merge/work-in-progress 🤖 PR should not merge because it is a work in progress. label Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-ok-to-test 🤖 Needs an org member to approve testing size/M 🤖 PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add unit tests for BufferWriter in cmd/ci/writer.go

2 participants