firebase-functions-test - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #machine-learning #rust #nodejs #awesome #cli #vue #awesome-list #security #mcp #openai #ios #open-source

firebase-functions-test

(★ 247)

No description available.

파일 탐색기

최종 버전 다운로드 (.zip)

- - test.yaml
- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- - cloudbuild.yaml
  - deploy_key.enc
  - hub.enc
  - npmrc.enc
- - cloudbuild.yaml
  - Dockerfile
- publish.sh
- tweet.js
- - generate.ts
- - database.spec.ts
  - firestore.spec.ts
  - https.spec.ts
  - scheduled.spec.ts
- app.spec.ts
- index.spec.ts
- lifecycle.spec.ts
- main.spec.ts
- secretmanager.spec.ts
- v2.spec.ts
- - generate.ts
  - types.ts
- - analytics.ts
  - auth.ts
  - database.ts
  - firestore.ts
  - pubsub.ts
  - storage.ts
- app.ts
- features.ts
- index.ts
- lifecycle.ts
- main.ts
- secretManager.ts
- v1.ts
- v2.ts
.eslintrc.json
.gitignore
.npmignore
.prettierrc
CHANGELOG.md
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tsconfig.release.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Firebase Test SDK for Cloud Functions

The `firebase-functions-test` is unit testing library for Cloud Functions for Firebase. It is a companion to [firebase-functions](https://github.com/Firebase/firebase-functions).

_NOTE: The minimum supported `firebase-functions` version is defined by this package's `peerDependencies` in [package.json](package.json)._

## Usage

1. Write some Firebase Functions
2. With your testing framework of choice, write a unit-test that imports your Firebase Functions.
3. `wrap` your Firebase Functions. You can invoke the Firebase Function's handler by invoking the `wrap` call.

Eg.

```typescript
import {myFirebaseFunction} from "../index"; // Your Firebase Functions
import firebaseFunctionsTest from "firebase-functions-test";

// Extracting `wrap` out of the lazy-loaded features
const {wrap} = firebaseFunctionsTest();

// `jest-ts` example
test('my unit test', () => {
  const wrappedFirebaseFunction = wrap(myFirebaseFunction);

// Invoke the firebase function
  wrappedFirebaseFunction();

// Invoke the firebase function with CloudEvent overrides
  wrappedFirebaseFunction({data: {arbitrary: 'values'}});
});
```

## Examples

* [Unit Testing Gen-1 Cloud Functions using Mocha](https://github.com/firebase/functions-samples/tree/main/Node-1st-gen/quickstarts/uppercase-rtdb/functions)
* [Unit Testing Gen-2 Cloud Functions using Mocha](https://github.com/firebase/functions-samples/tree/main/Node/test-functions-mocha/functions)
* [Unit Testing Gen-2 Cloud Functions using Jest](https://github.com/firebase/functions-samples/tree/main/Node/test-functions-jest/functions)
* [Unit Testing Gen-2 Cloud Functions using Jest-Ts](https://github.com/firebase/functions-samples/tree/main/Node/test-functions-jest-ts/functions)

## Learn more

Learn more about unit testing Cloud Functions [here](https://firebase.google.com/docs/functions/unit-testing).

## Contributing

To contribute a change, [check out the contributing guide](.github/CONTRIBUTING.md).

## License

© Google, 2018. Licensed under [The MIT License](LICENSE).