Kiểm thử hàm theo cách tương tác

shell Hàm Cloud cung cấp một shell tương tác để gọi các hàm có dữ liệu kiểm thử. Shell hỗ trợ tất cả các loại trình kích hoạt.

Thiết lập thông tin đăng nhập của quản trị viên (không bắt buộc)

Nếu muốn các bài kiểm thử hàm tương tác với API của Google hoặc các API Firebase khác thông qua SDK quản trị của Firebase, bạn có thể cần phải thiết lập thông tin đăng nhập quản trị viên.

  • Các trình kích hoạt Cloud Firestore và Cơ sở dữ liệu theo thời gian thực đã có đủ thông tin đăng nhập và không yêu cầu thiết lập thêm.
  • Tất cả những API khác, bao gồm cả API Firebase (chẳng hạn như API Xác thực và FCM) hoặc API của Google (chẳng hạn như Cloud Translation hay Cloud Speech) đều cần thực hiện các bước thiết lập như mô tả trong phần này. Điều này được áp dụng cho dù bạn đang sử dụng shell hàm Cloud hay firebase emulators:start.

Cách thiết lập thông tin đăng nhập quản trị cho các hàm được mô phỏng:

  1. Mở ngăn Tài khoản dịch vụ của bảng điều khiển Google Cloud.
  2. Hãy đảm bảo bạn đã chọn Tài khoản dịch vụ mặc định của App Engine và sử dụng trình đơn tuỳ chọn ở bên phải để chọn Create key (Tạo khoá).
  3. Khi thấy lời nhắc, hãy chọn JSON cho loại khoá rồi nhấp vào Tạo.
  4. Đặt thông tin xác thực mặc định trên Google của bạn để trỏ đến khoá đã tải xuống:

    Unix

    export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
    firebase functions:shell
    

    Windows

    set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
    firebase functions:shell
    

Sau khi hoàn tất những bước này, các bài kiểm thử chức năng của bạn có thể truy cập vào Firebase và API Google bằng SDK quản trị. Ví dụ: khi kiểm thử trình kích hoạt Xác thực, hàm được mô phỏng có thể gọi admin.auth().getUserByEmail(email).

Cung cấp các hàm sử dụng shell Chức năng đám mây

shell Hàm Cloud mô phỏng tất cả các loại điều kiện kích hoạt hàm có shell tương tác để gọi hàm bằng dữ liệu kiểm thử. Các tuỳ chọn khác nhau tuỳ theo loại hàm, nhưng định dạng sử dụng cơ bản là:

myFunctionName(data, options)

Bạn bắt buộc phải sử dụng tham số data cho điều kiện kích hoạt Cơ sở dữ liệu theo thời gian thực, Cloud Firestore và PubSub. Ngoài ra, bạn không bắt buộc phải sử dụng tham số này đối với tất cả các loại hàm khác. Ngoài ra, tham số options không bắt buộc chỉ hợp lệ đối với các hàm Cơ sở dữ liệu theo thời gian thực và Cloud Firestore.

Nếu muốn, bạn có thể tải dữ liệu kiểm thử từ một tệp cục bộ bằng cách lưu tệp dưới dạng biến và gọi một hàm cùng với tệp đó:

var data = require('./path/to/testData.json');
myFunction(data);

Cài đặt và định cấu hình shell Chức năng đám mây

Để sử dụng tính năng này, firebase-tools phải có phiên bản tối thiểu là 3.11.0 và SDK firebase-functions tối thiểu phải có phiên bản 0.6.2. Để cập nhật cả hai, hãy chạy các lệnh sau trong thư mục functions/ cho dự án của bạn:

npm install --save firebase-functions@latest
npm install -g firebase-tools

Nếu bạn đang sử dụng biến cấu hình của hàm tuỳ chỉnh, trước tiên, hãy chạy lệnh để lấy cấu hình tuỳ chỉnh của bạn (chạy lệnh này trong thư mục functions) trong môi trường cục bộ:

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json

Cuối cùng, hãy chạy shell bằng lệnh sau:

firebase functions:shell

Gọi các hàm HTTPS

Đối với việc gọi hàm HTTPS trong shell, cách sử dụng cũng giống như mô-đun cpc request nhưng thay thế request bằng tên hàm mà bạn muốn mô phỏng. Ví dụ:

# invoke
myHttpsFunction()
myHttpsFunction.get()
myHttpsFunction.post()

# invoke at sub-path
myHttpsFunction('/path')
myHttpsFunction.get('/path')
myHttpsFunction.post('/path')

# send POST request with form data
myHttpsFunction.post('/path').form( {foo: 'bar' })

Gọi các hàm HTTPS có thể gọi

Khi gọi các hàm có thể gọi HTTPS cục bộ, bạn cần cung cấp dữ liệu thử nghiệm thích hợp.

# invoke
myCallableFunction('test data')
myCallableFunction({'foo': 'bar'})

Nếu muốn, bạn có thể truyền Firebase-Instance-ID-token làm tham số thứ hai. Đây phải là một chuỗi.

# invoke with FCM registration token
myCallableFunction('test data', {instanceIdToken: 'sample token'})

Hiện không thể mô phỏng context.auth.

Gọi các hàm Cơ sở dữ liệu theo thời gian thực

Khi chạy các hàm Cơ sở dữ liệu theo thời gian thực trên máy, bạn cần cung cấp dữ liệu kiểm thử phù hợp. Điều này thường có nghĩa là cung cấp dữ liệu kiểm thử mới cho các thao tác onCreate, dữ liệu cũ/đã xoá cho các thao tác onDelete và cả hai cho các hàm onUpdate hoặc onWrite:

# invoke onCreate function
myDatabaseFunction('new_data')

# invoke onDelete function
myDatabaseFunction('old_data')

# invoke onUpdate or onWrite function
myDatabaseFunction({before: 'old_data', after: 'new_data' })

Ngoài các tuỳ chọn before/after, shell cung cấp tuỳ chọn params để sử dụng trong việc mô phỏng các ký tự đại diện trong một đường dẫn:

# mock wildcards in path, for example: if the path was input/{group}/{id}
myDatabaseFunction('data', {params: {group: 'a', id: 123}})

Theo mặc định, shell chạy các hàm Cơ sở dữ liệu theo thời gian thực có đặc quyền quản trị viên (tài khoản dịch vụ). Sử dụng tuỳ chọn auth để chạy các hàm với tư cách là một người dùng cuối cụ thể hoặc với tư cách người dùng chưa xác thực:

# to mock unauthenticated user
myDatabaseFunction('data', {authMode: 'USER'})
# to mock end user
myDatabaseFunction('data', {auth: {uid: 'abcd'}})

Gọi các hàm Firestore

Khi chạy các hàm Firestore cục bộ, bạn cần cung cấp dữ liệu kiểm thử phù hợp. Điều này thường có nghĩa là cung cấp dữ liệu kiểm thử mới cho các thao tác onCreate, dữ liệu cũ/đã bị xoá cho các thao tác onDelete và cho cả hai hàm onUpdate hoặc onWrite. Lưu ý rằng dữ liệu Firestore phải là các cặp khoá-giá trị; hãy xem phần Các loại dữ liệu được hỗ trợ.

# invoke onCreate function
myFirestoreFunction({foo: ‘new’})

# invoke onDelete function
myFirestoreFunction({foo: ‘old’})

# invoke onUpdate or onWrite function
myFirestoreFunction({before: {foo: ‘old’}, after: {foo: ‘new’} })

Ngoài các trường before/after của đối tượng data, bạn có thể sử dụng các trường params trên đối tượng options để mô phỏng ký tự đại diện trong tên tài liệu:

# mock wildcards in document name, for example: if the name was input/{group}/{id}
myFirestoreFunction({foo: ‘new’}, {params: {group: 'a', id: 123}})

shell luôn chạy các hàm Firestore có các đặc quyền của quản trị viên, tức là mô phỏng một sự kiện tạo/cập nhật/xoá như thể do người dùng có quyền quản trị thực hiện.

Gọi hàm PubSub

Đối với các hàm PubSub, hãy chèn tải trọng thông báo của bạn vào thực thể Buffer và thêm các thuộc tính dữ liệu tuỳ ý như sau:

// invokes a function with the JSON message { hello: 'world' } and attributes { foo: 'bar' }
myPubsubFunction({data: new Buffer('{"hello":"world"}'), attributes: {foo: 'bar'}})

Gọi các hàm Analytics

Bạn có thể gọi một hàm Analytics mà không cần dữ liệu bằng cách chạy myAnalyticsFunction() trong shell. Để chạy hàm với dữ liệu kiểm thử, bạn nên xác định một biến cho các trường dữ liệu sự kiện cụ thể mà hàm của bạn cần:

var data = {
  eventDim: [{
    // populates event.data.params
    params: {foo: {stringValue: 'bar'} },
    // Also valid:
    //   {intValue: '10'}, {floatValue: '1.0'}, {doubleValue: '1.0'}
    // populates event.data.name
    name: 'event_name',
    // populates event.data.logTime, specify in microseconds
    timestampMicros: Date.now() * 1000,
    // populates event.data.previousLogTime, specify in microseconds
    previousTimestampMicros: Date.now() * 1000,
    // populates event.data.reportingDate, specify in 'YYYYMMDD' format
    date: '20170930',
    // populates event.data.valueInUSD
    valueInUsd: 230
  }],
  userDim: userDim
};

myAnalyticsFunction(data);

Gọi các hàm Bộ nhớ và Xác thực

Đối với hàm Lưu trữ và Xác thực, hãy gọi hàm cục bộ bằng dữ liệu kiểm thử mà bạn muốn xem bên trong hàm đó. Dữ liệu kiểm thử của bạn phải tuân theo các định dạng dữ liệu tương ứng:

Chỉ chỉ định các trường mà mã của bạn phụ thuộc vào hoặc hoàn toàn không chỉ định các trường nếu bạn chỉ muốn chạy hàm đó.