Files
firebase-ios-sdk/FirebaseStorage/Tests/Unit/StorageMetadataTests.swift
T

314 lines
12 KiB
Swift

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import Foundation
@testable import FirebaseStorage
import GTMSessionFetcherCore
import XCTest
class StorageMetadataTests: StorageTestHelpers {
func testInitializeNoMetadata() {
let metadata = StorageMetadata(dictionary: [:])
XCTAssertNotNil(metadata)
}
func testInitializeFullMetadata() {
let metaDict = [
"bucket": "bucket",
"cacheControl": "max-age=3600, no-cache",
"contentDisposition": "inline",
"contentEncoding": "gzip",
"contentLanguage": "en-us",
"contentType": "application/octet-stream",
"customMetadata": ["foo": ["bar": "baz"]],
"generation": "12345",
"metageneration": "67890",
"name": "path/to/object",
"timeCreated": "1992-08-07T17:22:53.108Z",
"updated": "2016-03-01T20:16:01.673Z",
"md5Hash": "d41d8cd98f00b204e9800998ecf8427e",
"size": 1337,
] as [String: AnyHashable]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
XCTAssertEqual(metadata.bucket, metaDict["bucket"] as? String)
XCTAssertEqual(metadata.cacheControl, metaDict["cacheControl"] as? String)
XCTAssertEqual(metadata.contentDisposition, metaDict["contentDisposition"] as? String)
XCTAssertEqual(metadata.contentEncoding, metaDict["contentEncoding"] as? String)
XCTAssertEqual(metadata.contentType, metaDict["contentType"] as? String)
XCTAssertEqual(metadata.customMetadata, metaDict["customMetadata"] as? [String: String])
XCTAssertEqual(metadata.md5Hash, metaDict["md5Hash"] as? String)
XCTAssertEqual("\(metadata.generation)", "12345")
XCTAssertEqual("\(metadata.metageneration)", "67890")
XCTAssertEqual(metadata.path, metaDict["name"] as? String)
XCTAssertEqual(StorageMetadata.RFC3339StringFromDate(metadata.timeCreated!),
metaDict["timeCreated"] as? String)
XCTAssertEqual(StorageMetadata.RFC3339StringFromDate(metadata.updated!),
metaDict["updated"] as? String)
XCTAssertEqual(metadata.size, 1337)
}
func testDictionaryRepresentation() {
let metaDict = [
"bucket": "bucket",
"cacheControl": "max-age=3600, no-cache",
"contentDisposition": "inline",
"contentEncoding": "gzip",
"contentLanguage": "en-us",
"contentType": "application/octet-stream",
"customMetadata": ["foo": ["bar": "baz"]],
"generation": "12345",
"metageneration": "67890",
"name": "path/to/object",
"timeCreated": "1992-08-07T17:22:53.108Z",
"updated": "2016-03-01T20:16:01.673Z",
"md5Hash": "d41d8cd98f00b204e9800998ecf8427e",
"size": 1337,
] as [String: AnyHashable]
let metadata = StorageMetadata(dictionary: metaDict)
let dictRepresentation = metadata.dictionaryRepresentation()
XCTAssertNotNil(dictRepresentation)
XCTAssertEqual(dictRepresentation["bucket"] as? String, metaDict["bucket"] as? String)
XCTAssertEqual(
dictRepresentation["cacheControl"] as? String,
metaDict["cacheControl"] as? String
)
XCTAssertEqual(
dictRepresentation["contentDisposition"] as? String,
metaDict["contentDisposition"] as? String
)
XCTAssertEqual(
dictRepresentation["contentEncoding"] as? String,
metaDict["contentEncoding"] as? String
)
XCTAssertEqual(dictRepresentation["contentType"] as? String, metaDict["contentType"] as? String)
XCTAssertEqual(dictRepresentation["customMetadata"] as? [String: String],
metaDict["customMetadata"] as? [String: String])
XCTAssertEqual(dictRepresentation["md5Hash"] as? String, metaDict["md5Hash"] as? String)
XCTAssertEqual(dictRepresentation["generation"] as? String, "12345")
XCTAssertEqual(dictRepresentation["metageneration"] as? String, "67890")
XCTAssertEqual(dictRepresentation["name"] as? String, metaDict["name"] as? String)
XCTAssertEqual(dictRepresentation["timeCreated"] as? String,
metaDict["timeCreated"] as? String)
XCTAssertEqual(dictRepresentation["updated"] as? String,
metaDict["updated"] as? String)
XCTAssertEqual(dictRepresentation["size"] as? Int64, 1337)
}
func testInitializeEmptyDownloadURL() {
let metaDict = ["bucket": "bucket", "name": "/path/to/object"]
let rootReference = rootReference()
let task = StorageGetDownloadURLTask(reference: rootReference,
fetcherService: GTMSessionFetcherService(),
queue: DispatchQueue.main,
completion: nil)
let actualURL = task.downloadURLFromMetadataDictionary(metaDict)
XCTAssertNil(actualURL)
}
func testInitializeDownloadURLFromToken() {
let metaDict = [
"bucket": "bucket",
"downloadTokens": "12345,ignored",
"name": "path/to/object",
] as [String: String]
let rootReference = rootReference()
let escapedPath = StorageUtils.GCSEscapedString(metaDict["name"]!)
let expectedURL =
"https://firebasestorage.googleapis.com:443/v0/b/bucket/o/\(escapedPath)?alt=media&token=12345"
let task = StorageGetDownloadURLTask(reference: rootReference,
fetcherService: GTMSessionFetcherService(),
queue: DispatchQueue.main,
completion: nil)
let actualURL = task.downloadURLFromMetadataDictionary(metaDict)
XCTAssertEqual(actualURL?.absoluteString, expectedURL)
}
// Regression test for #10370
func testInitializeDownloadURLFromTokenWithEmptyMetadata() {
let metaDict = [
"bucket": "bucket",
"downloadTokens": "12345,ignored",
"name": "path/to/object",
"metadata": {},
] as [String: Any]
let rootReference = rootReference()
let escapedPath = StorageUtils.GCSEscapedString("path/to/object")
let expectedURL =
"https://firebasestorage.googleapis.com:443/v0/b/bucket/o/\(escapedPath)?alt=media&token=12345"
let task = StorageGetDownloadURLTask(reference: rootReference,
fetcherService: GTMSessionFetcherService(),
queue: DispatchQueue.main,
completion: nil)
let actualURL = task.downloadURLFromMetadataDictionary(metaDict)
XCTAssertEqual(actualURL?.absoluteString, expectedURL)
}
func testInitializeMetadataWithFile() {
let metaDict = ["bucket": "bucket", "name": "/path/to/file"]
let metadata = StorageMetadata(dictionary: metaDict)
metadata.fileType = .file
XCTAssertTrue(metadata.isFile)
XCTAssertFalse(metadata.isFolder)
}
func testInitializeMetadataWithFolder() {
let metaDict = ["bucket": "bucket", "name": "/path/to/folder"]
let metadata = StorageMetadata(dictionary: metaDict)
metadata.fileType = .folder
XCTAssertFalse(metadata.isFile)
XCTAssertTrue(metadata.isFolder)
}
func testReflexiveMetadataEquality() {
let metaDict = ["bucket": "bucket", "name": "/path/to/file"]
let metadata0 = StorageMetadata(dictionary: metaDict)
let metadata1 = metadata0
XCTAssertEqual(metadata0, metadata1)
}
func testNonsenseMetadataEquality() {
let metaDict = [
"bucket": "bucket",
"name": "path/to/object",
] as [String: String]
let metadata0 = StorageMetadata(dictionary: metaDict)
XCTAssertNotEqual(metadata0, StorageMetadata())
}
func testMetadataEquality() {
let metaDict = [
"bucket": "bucket",
"name": "/path/to/file",
"md5Hash": "d41d8cd98f00b204e9800998ecf8427e",
]
let metadata0 = StorageMetadata(dictionary: metaDict)
let metadata1 = StorageMetadata(dictionary: metaDict)
XCTAssertEqual(metadata0, metadata1)
}
func testMetadataMd5Inequality() {
let metaDict0 = ["md5Hash": "d41d8cd98f00b204e9800998ecf8427e"]
let metaDict1 = ["md5Hash": "d41d8cd98f00b204e9800998ecf8427f"]
let metadata0 = StorageMetadata(dictionary: metaDict0)
let metadata1 = StorageMetadata(dictionary: metaDict1)
XCTAssertNotEqual(metadata0, metadata1)
}
func testMetadataCopy() {
let metaDict = [
"bucket": "bucket",
"name": "/path/to/file",
"md5Hash": "d41d8cd98f00b204e9800998ecf8427e",
]
let metadata0 = StorageMetadata(dictionary: metaDict)
let metadata1 = metadata0.copy() as? StorageMetadata
// Verify that copied object has a new reference.
XCTAssertFalse(metadata0 === metadata1)
XCTAssertEqual(metadata0, metadata1)
}
func testUpdatedMetadata() {
let oldMetadata = [
"contentLanguage": "old",
"metadata": ["foo": "old", "bar": "old"],
] as [String: AnyHashable]
let metadata = StorageMetadata(dictionary: oldMetadata)
metadata.contentLanguage = "new"
metadata.customMetadata = ["foo": "new", "bar": "old"]
let update = metadata.updatedMetadata()
let expectedUpdate = [
"contentLanguage": "new",
"metadata": ["foo": "new"],
"bucket": "",
] as [String: AnyHashable]
XCTAssertEqual(update, expectedUpdate)
}
func testUpdatedMetadataWithEmptyUpdate() {
let oldMetadata = [
"contentLanguage": "old",
"metadata": ["foo": "old", "bar": "old"],
] as [String: AnyHashable]
let metadata = StorageMetadata(dictionary: oldMetadata)
let update = metadata.updatedMetadata()
XCTAssertEqual(update, ["bucket": ""])
}
func testUpdatedMetadataWithDelete() {
let oldMetadata = [
"contentLanguage": "old",
"metadata": ["foo": "old", "bar": "old"],
] as [String: AnyHashable]
let metadata = StorageMetadata(dictionary: oldMetadata)
metadata.contentLanguage = nil
metadata.customMetadata = ["foo": "old"]
let update = metadata.updatedMetadata()
let expected = ["bucket": "",
"contentLanguage": NSNull(),
"metadata": ["bar": NSNull()]] as [String: AnyHashable]
XCTAssertEqual(update, expected)
}
func testMetadataHashEquality() {
let metaDict = [
"bucket": "bucket",
"name": "path/to/object",
] as [String: String]
let metadata0 = StorageMetadata(dictionary: metaDict)
let metadata1 = StorageMetadata(dictionary: metaDict)
XCTAssertFalse(metadata0 === metadata1)
XCTAssertTrue(metadata0 == metadata1)
XCTAssertEqual(metadata0.hash, metadata1.hash)
}
func testZuluTimeOffset() {
let metaDict = ["timeCreated": "1992-08-07T17:22:53.108Z"]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
}
func testZuluZeroTimeOffset() {
let metaDict = ["timeCreated": "1992-08-07T17:22:53.108+0000"]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
}
func testGoogleStandardTimeOffset() {
let metaDict = ["timeCreated": "1992-08-07T17:22:53.108-0700"]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
}
func testUnspecifiedTimeOffset() {
let metaDict = ["timeCreated": "1992-08-07T17:22:53.108-0000"]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
}
func testNoTimeOffset() {
let metaDict = ["timeCreated": "1992-08-07T17:22:53.108"]
let metadata = StorageMetadata(dictionary: metaDict)
XCTAssertNotNil(metadata)
}
}