Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Vertex AI] Add README for unit test mock files #13233

Merged
merged 3 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions FirebaseVertexAI/Tests/Unit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Vertex AI for Firebase Unit Tests

> [!IMPORTANT]
> These unit tests require mock response files, which can be downloaded by
running `scripts/update_vertexai_responses.sh` from the root of this repository.

## Updating Mock Responses

To update the mock responses, create a PR in the
[`vertexai-sdk-test-data`](https://github.com/FirebaseExtended/vertexai-sdk-test-data)
repo. After it is merged, re-run the
[script](https://github.com/firebase/firebase-ios-sdk/blob/main/scripts/update_vertexai_responses.sh)
above to download the updated files.
3 changes: 3 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1379,6 +1379,9 @@ let package = Package(
path: "FirebaseVertexAI/Tests/Unit",
resources: [
.process("vertexai-sdk-test-data/mock-responses"),
// Including this README ensures that SPM will always generate a `Bundle.module`, even if
// the mock-responses have not been downloaded with the update_vertexai_responses.sh script.
.process("README.md"),
],
cSettings: [
.headerSearchPath("../../../"),
Expand Down
Loading