android_system_core/libutils/binder/String8_test.cpp

/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * 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.
 */

#define LOG_TAG "String8_test"

#include <log/log.h>
#include <utils/String16.h>
#include <utils/String8.h>
#include <compare>
#include <utility>

#include <gtest/gtest.h>

using namespace android;

class String8Test : public testing::Test {
protected:
    virtual void SetUp() {
    }

    virtual void TearDown() {
    }
};

TEST_F(String8Test, Cstr) {
    String8 tmp("Hello, world!");

    EXPECT_STREQ(tmp.c_str(), "Hello, world!");
}

TEST_F(String8Test, OperatorPlus) {
    String8 src1("Hello, ");

    // Test adding String8 + const char*
    const char* ccsrc2 = "world!";
    String8 dst1 = src1 + ccsrc2;
    EXPECT_STREQ(dst1.c_str(), "Hello, world!");
    EXPECT_STREQ(src1.c_str(), "Hello, ");
    EXPECT_STREQ(ccsrc2, "world!");

    // Test adding String8 + String8
    String8 ssrc2("world!");
    String8 dst2 = src1 + ssrc2;
    EXPECT_STREQ(dst2.c_str(), "Hello, world!");
    EXPECT_STREQ(src1.c_str(), "Hello, ");
    EXPECT_STREQ(ssrc2.c_str(), "world!");
}

TEST_F(String8Test, OperatorPlusEquals) {
    String8 src1("My voice");

    // Testing String8 += String8
    String8 src2(" is my passport.");
    src1 += src2;
    EXPECT_STREQ(src1.c_str(), "My voice is my passport.");
    EXPECT_STREQ(src2.c_str(), " is my passport.");

    // Adding const char* to the previous string.
    const char* src3 = " Verify me.";
    src1 += src3;
    EXPECT_STREQ(src1.c_str(), "My voice is my passport. Verify me.");
    EXPECT_STREQ(src2.c_str(), " is my passport.");
    EXPECT_STREQ(src3, " Verify me.");
}

TEST_F(String8Test, SetToSizeMaxReturnsNoMemory) {
    const char *in = "some string";
    EXPECT_EQ(NO_MEMORY, String8("").setTo(in, SIZE_MAX));
}

// http://b/29250543
TEST_F(String8Test, CorrectInvalidSurrogate) {
    // d841d8 is an invalid start for a surrogate pair. Make sure this is handled by ignoring the
    // first character in the pair and handling the rest correctly.
    String16 string16(u"\xd841\xd841\xdc41\x0000");
    String8 string8(string16);

    EXPECT_EQ(4U, string8.length());
}

TEST_F(String8Test, CheckUtf32Conversion) {
    // Since bound checks were added, check the conversion can be done without fatal errors.
    // The utf8 lengths of these are chars are 1 + 2 + 3 + 4 = 10.
    const char32_t string32[] = U"\x0000007f\x000007ff\x0000911\x0010fffe";
    String8 string8(string32);
    EXPECT_EQ(10U, string8.length());
}

TEST_F(String8Test, ValidUtf16Conversion) {
    char16_t tmp[] = u"abcdef";
    String8 valid = String8(String16(tmp));
    EXPECT_STREQ(valid.c_str(), "abcdef");
}

TEST_F(String8Test, append) {
    String8 s;
    EXPECT_EQ(OK, s.append("foo"));
    EXPECT_STREQ("foo", s.c_str());
    EXPECT_EQ(OK, s.append("bar"));
    EXPECT_STREQ("foobar", s.c_str());
    EXPECT_EQ(OK, s.append("baz", 0));
    EXPECT_STREQ("foobar", s.c_str());
    EXPECT_EQ(NO_MEMORY, s.append("baz", SIZE_MAX));
    EXPECT_STREQ("foobar", s.c_str());
}

TEST_F(String8Test, removeAll) {
    String8 s("Hello, world!");

    // NULL input should cause an assertion failure and error message in logcat
    EXPECT_DEATH(s.removeAll(NULL), "");

    // expect to return true and string content should remain unchanged
    EXPECT_TRUE(s.removeAll(""));
    EXPECT_STREQ("Hello, world!", s.c_str());

    // expect to return false
    EXPECT_FALSE(s.removeAll("x"));
    EXPECT_STREQ("Hello, world!", s.c_str());

    EXPECT_TRUE(s.removeAll("o"));
    EXPECT_STREQ("Hell, wrld!", s.c_str());
}

TEST_F(String8Test, comparisons) {
    const char* cstr1 = "abc";
    const char* cstr2 = "def";

    // str1 and str1b will point to different blocks of memory but with equal contents.
    String8 str1(cstr1);
    String8 str1b(cstr1);
    String8 str2(cstr2);

    EXPECT_TRUE((str1 <=> str1b) == 0);
    EXPECT_FALSE(str1 != str1b);
    EXPECT_FALSE(str1 < str1b);
    EXPECT_TRUE(str1 <= str1b);
    EXPECT_TRUE(str1 == str1b);
    EXPECT_TRUE(str1 >= str1b);
    EXPECT_FALSE(str1 > str1b);

    EXPECT_TRUE((str1 <=> str2) < 0);
    EXPECT_TRUE((str2 <=> str1) > 0);
    EXPECT_TRUE(str1 != str2);
    EXPECT_TRUE(str1 < str2);
    EXPECT_TRUE(str1 <= str2);
    EXPECT_FALSE(str1 == str2);
    EXPECT_FALSE(str1 >= str2);
    EXPECT_FALSE(str1 > str2);

    // Verify that pre-C++20 comparison operators work with a std::pair of a String8, which only
    // provides <=> in C++20 and up. See b/339775405.

    std::pair<String8, int> pair1(str1, 13);
    std::pair<String8, int> pair1b(str1b, 13);
    std::pair<String8, int> pair2(str2, 13);

    EXPECT_TRUE(pair1 == pair1b);
    EXPECT_FALSE(pair1 < pair1b);
    EXPECT_FALSE(pair1 > pair1b);

    EXPECT_TRUE(pair1 != pair2);
    EXPECT_TRUE(pair1 < pair2);
    EXPECT_FALSE(pair1 > pair2);
}