├── .gitignore
├── README.md
├── firebase.json
├── firestore.rules
├── package-lock.json
├── package.json
├── test
    └── rules.test.ts
└── tsconfig.json


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log
3 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # firebase-rules-unit-testing-v2
 2 | 
 3 | 書き方が知りたい人は `test/rules.test.ts` を見るのがよいです。
 4 | 
 5 | ## 使い方
 6 | 
 7 | ```
 8 | $ npm i
 9 | $ npm run test
10 | ```
11 | 


--------------------------------------------------------------------------------
/firebase.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "firestore": {
 3 |     "rules": "firestore.rules"
 4 |   },
 5 |   "emulators": {
 6 |     "firestore": {
 7 |       "port": 8080
 8 |     }
 9 |   }
10 | }
11 | 


--------------------------------------------------------------------------------
/firestore.rules:
--------------------------------------------------------------------------------
 1 | rules_version = '2';
 2 | service cloud.firestore {
 3 |   match /databases/{database}/documents {
 4 |     match /users/{userID} {
 5 |       allow create: if userID == request.auth.uid
 6 |         && request.resource.data.createdAt == request.time
 7 |         && request.resource.data.updatedAt == request.time
 8 |       ;
 9 | 
10 |       allow update: if userID == request.auth.uid
11 |         && request.resource.data.createdAt == resource.data.createdAt
12 |         && request.resource.data.updatedAt == request.time
13 |       ;
14 |     }
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "firebase-rules-unit-testing-v2",
 3 |   "version": "1.0.0",
 4 |   "description": "",
 5 |   "scripts": {
 6 |     "test": "firebase emulators:exec --only firestore 'jest'"
 7 |   },
 8 |   "devDependencies": {
 9 |     "@firebase/rules-unit-testing": "^2.0.1",
10 |     "@types/jest": "^27.0.2",
11 |     "@types/uuid": "^8.3.1",
12 |     "jest": "^27.2.4",
13 |     "ts-jest": "^27.0.5",
14 |     "typescript": "^4.4.3",
15 |     "uuid": "^8.3.2"
16 |   },
17 |   "jest": {
18 |     "moduleFileExtensions": [
19 |       "ts",
20 |       "js",
21 |       "json"
22 |     ],
23 |     "transform": {
24 |       "^.+\\.ts$": "ts-jest"
25 |     },
26 |     "testMatch": [
27 |       "**/*.test.ts"
28 |     ]
29 |   },
30 |   "dependencies": {
31 |     "firebase": "^9.1.1"
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/test/rules.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs'
 2 | import { v4 } from "uuid"
 3 | import * as firebase from '@firebase/rules-unit-testing'
 4 | 
 5 | // Firebase JS SDKのserverTimestampを使う
 6 | import { serverTimestamp as st} from 'firebase/firestore'
 7 | const serverTimestamp = () => st()
 8 | 
 9 | // rules-unit-testingについてくる firebase/compat のほうを使っても良い
10 | // import firebaseApp from 'firebase/compat'
11 | // const serverTimestamp = () => firebaseApp.firestore.FieldValue.serverTimestamp()
12 | 
13 | const projectID = v4()
14 | let testEnv: firebase.RulesTestEnvironment
15 | 
16 | beforeAll(async () => {
17 |   // テストプロジェクト環境の作成
18 |   testEnv = await firebase.initializeTestEnvironment({
19 |     projectId: projectID,
20 |     firestore: {
21 |       rules: fs.readFileSync('./firestore.rules', 'utf8')
22 |     }
23 |   })
24 | })
25 | 
26 | beforeEach(async () => {
27 |   await testEnv.clearFirestore()
28 | })
29 | 
30 | afterAll(async () => {
31 |   await testEnv.cleanup()
32 | })
33 | 
34 | describe('users collection', () => {
35 |   it('create: 自身のドキュメントなら作成できる', async () => {
36 |     const uid = v4()
37 |     const context = testEnv.authenticatedContext(uid)
38 |     await firebase.assertSucceeds(
39 |       context.firestore().doc(`users/${uid}`).set({
40 |         createdAt: serverTimestamp(),
41 |         updatedAt: serverTimestamp(),
42 |       })
43 |     )
44 |   })
45 | 
46 |   it('create: 他人のドキュメントには作成できない', async () => {
47 |     // 別人としてcontextを作成
48 |     const context = testEnv.authenticatedContext(v4())
49 | 
50 |     const uid = v4()
51 |     await firebase.assertFails(
52 |       context.firestore().doc(`users/${uid}`).set({
53 |         createdAt: serverTimestamp(),
54 |         updatedAt: serverTimestamp(),
55 |       })
56 |     )
57 |   })
58 | 
59 |   it('create: 未認証だと作成できない', async () => {
60 |     const context = testEnv.unauthenticatedContext()
61 |     await firebase.assertFails(
62 |       context.firestore().doc(`users/${v4()}`).set({
63 |         createdAt: serverTimestamp(),
64 |         updatedAt: serverTimestamp(),
65 |       })
66 |     )
67 |   })
68 | 
69 |   it('update: 自分のデータは編集できる', async () => {
70 |     const uid = v4()
71 | 
72 |     // データの事前準備はルール向こうのコンテキストを使って行う
73 |     await testEnv.withSecurityRulesDisabled(async context => {
74 |       await context.firestore().doc(`users/${uid}`).set({
75 |         createdAt: serverTimestamp(),
76 |         updatedAt: serverTimestamp(),
77 |       })
78 |     })
79 | 
80 |     const context = testEnv.authenticatedContext(uid)
81 |     await firebase.assertSucceeds(
82 |       context.firestore().doc(`users/${uid}`).set({
83 |         updatedAt: serverTimestamp(),
84 |       }, { merge: true })
85 |     )
86 |   })
87 | })
88 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |   "compilerOptions": {
3 |     "target": "esnext",
4 |     "module": "commonjs",
5 |     "sourceMap": true,
6 |     "outDir": "build"
7 |   }
8 | }
9 | 


--------------------------------------------------------------------------------