Skip to content

Add flaky test handling for Storage test #531

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 13, 2021
Merged

Add flaky test handling for Storage test #531

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71d16d9
Add flaky test retry to TestPutFileAndGetFile in Storage.
jonsimantov Jul 13, 2021
e841a93
Format code.
jonsimantov Jul 13, 2021
e2dba90
Merge branch 'main' into bugfix/flaky-test-3
jonsimantov Jul 13, 2021
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
152 changes: 84 additions & 68 deletions storage/integration_test/src/integration_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ class FirebaseStorageTest : public FirebaseTest {
// Called after each test.
void TearDown() override;

// Create a unique working folder and return a reference to it.
firebase::storage::StorageReference CreateFolder();

// File references that we need to delete on test exit.
std::vector<firebase::storage::StorageReference>& cleanup_files() {
return cleanup_files_;
}

protected:
// Initialize Firebase App and Firebase Auth.
static void InitializeAppAndAuth();
Expand All @@ -97,9 +105,6 @@ class FirebaseStorageTest : public FirebaseTest {
// Shut down Firebase Storage.
void TerminateStorage();

// Create a unique working folder and return a reference to it.
firebase::storage::StorageReference CreateFolder();

static firebase::App* shared_app_;
static firebase::auth::Auth* shared_auth_;

Expand Down Expand Up @@ -496,72 +501,83 @@ const char kFileUriScheme[] = "file://";

TEST_F(FirebaseStorageTest, TestPutFileAndGetFile) {
SignIn();
firebase::storage::StorageReference ref =
CreateFolder().Child("TestFile-FileIO.txt");
cleanup_files_.push_back(ref);

// Upload a file.
{
// Write file that we're going to upload.
std::string path = PathForResource() + kPutFileTestFile;
// Cloud Storage expects a URI, so add file:// in front of local paths.
std::string file_path = kFileUriScheme + path;

LogDebug("Creating local file: %s", path.c_str());

FILE* file = fopen(path.c_str(), "wb");
std::fwrite(kSimpleTestFile.c_str(), 1, kSimpleTestFile.size(), file);
fclose(file);

firebase::storage::Metadata new_metadata;
std::string content_type = "text/plain";
new_metadata.set_content_type(content_type);

LogDebug("Uploading sample file from disk.");
firebase::Future<firebase::storage::Metadata> future =
ref.PutFile(file_path.c_str(), new_metadata);
WaitForCompletion(future, "PutFile");
ASSERT_NE(future.result(), nullptr);
const firebase::storage::Metadata* metadata = future.result();
EXPECT_EQ(metadata->size_bytes(), kSimpleTestFile.size());
EXPECT_EQ(metadata->content_type(), content_type);
}

// Use GetBytes to ensure the file uploaded correctly.
{
LogDebug("Downloading file to disk.");
const size_t kBufferSize = 1024;
char buffer[kBufferSize];
memset(buffer, 0, sizeof(buffer));

firebase::Future<size_t> future = ref.GetBytes(buffer, kBufferSize);
WaitForCompletion(future, "GetBytes");
ASSERT_NE(future.result(), nullptr);
size_t file_size = *future.result();
EXPECT_EQ(file_size, kSimpleTestFile.size());
EXPECT_THAT(kSimpleTestFile, ElementsAreArray(buffer, file_size))
<< "Read file to byte buffer failed, file contents did not match.";
}
// Test GetFile to ensure we can download to a file.
{
std::string path = PathForResource() + kGetFileTestFile;
// Cloud Storage expects a URI, so add file:// in front of local paths.
std::string file_path = kFileUriScheme + path;

LogDebug("Saving to local file: %s", path.c_str());

firebase::Future<size_t> future = ref.GetFile(file_path.c_str());
WaitForCompletion(future, "GetFile");
ASSERT_NE(future.result(), nullptr);
EXPECT_EQ(*future.result(), kSimpleTestFile.size());

std::vector<char> buffer(kSimpleTestFile.size());
FILE* file = fopen(path.c_str(), "rb");
ASSERT_NE(file, nullptr);
std::fread(&buffer[0], 1, kSimpleTestFile.size(), file);
fclose(file);
EXPECT_THAT(kSimpleTestFile, ElementsAreArray(&buffer[0], buffer.size()))
<< "Download to disk failed, file contents did not match.";
if (!RunFlakyBlock(
[](FirebaseStorageTest* this_) {
firebase::storage::StorageReference ref =
this_->CreateFolder().Child("TestFile-FileIO.txt");
this_->cleanup_files().push_back(ref);

// Upload a file.
{
// Write file that we're going to upload.
std::string path = PathForResource() + kPutFileTestFile;
// Cloud Storage expects a URI, so add file:// in front of local
// paths.
std::string file_path = kFileUriScheme + path;

LogDebug("Creating local file: %s", path.c_str());

FILE* file = fopen(path.c_str(), "wb");
std::fwrite(kSimpleTestFile.c_str(), 1, kSimpleTestFile.size(),
file);
fclose(file);

firebase::storage::Metadata new_metadata;
std::string content_type = "text/plain";
new_metadata.set_content_type(content_type);

LogDebug("Uploading sample file from disk.");
firebase::Future<firebase::storage::Metadata> future =
ref.PutFile(file_path.c_str(), new_metadata);
FLAKY_WAIT_FOR_COMPLETION(future, "PutFile");
FLAKY_EXPECT_NONNULL(future.result());
const firebase::storage::Metadata* metadata = future.result();
FLAKY_EXPECT_EQ(metadata->size_bytes(), kSimpleTestFile.size());
FLAKY_EXPECT_EQ(metadata->content_type(), content_type);
}
// Use GetBytes to ensure the file uploaded correctly.
{
LogDebug("Downloading file to disk.");
const size_t kBufferSize = 1024;
char buffer[kBufferSize];
memset(buffer, 0, sizeof(buffer));

firebase::Future<size_t> future =
ref.GetBytes(buffer, kBufferSize);
FLAKY_WAIT_FOR_COMPLETION(future, "GetBytes");
FLAKY_EXPECT_NONNULL(future.result());
size_t file_size = *future.result();
FLAKY_EXPECT_EQ(file_size, kSimpleTestFile.size());
FLAKY_EXPECT_EQ(
memcmp(&kSimpleTestFile[0], &buffer[0], file_size), 0);
}
// Test GetFile to ensure we can download to a file.
{
std::string path = PathForResource() + kGetFileTestFile;
// Cloud Storage expects a URI, so add file:// in front of local
// paths.
std::string file_path = kFileUriScheme + path;

LogDebug("Saving to local file: %s", path.c_str());

firebase::Future<size_t> future = ref.GetFile(file_path.c_str());
FLAKY_WAIT_FOR_COMPLETION(future, "GetFile");
FLAKY_EXPECT_NONNULL(future.result());
FLAKY_EXPECT_EQ(*future.result(), kSimpleTestFile.size());

std::vector<char> buffer(kSimpleTestFile.size());
FILE* file = fopen(path.c_str(), "rb");
FLAKY_EXPECT_NONNULL(file);
std::fread(&buffer[0], 1, kSimpleTestFile.size(), file);
fclose(file);
FLAKY_EXPECT_EQ(
memcmp(&kSimpleTestFile[0], &buffer[0], buffer.size()), 0);
}
return true;
},
this)) {
FAIL() << "Upload and download file failed, check log for details.";
}
}

Expand Down