/**
 *    Copyright (C) 2022-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include "mongo/db/database_name.h"

#include <absl/container/node_hash_map.h>

#include <boost/move/utility_core.hpp>
#include <boost/none.hpp>
#include <boost/optional/optional.hpp>

#include "mongo/bson/bsonmisc.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/namespace_string.h"
#include "mongo/idl/server_parameter_test_util.h"
#include "mongo/logv2/log.h"
#include "mongo/logv2/log_component.h"
#include "mongo/stdx/unordered_map.h"
#include "mongo/unittest/assert.h"
#include "mongo/unittest/framework.h"

#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kDefault

namespace mongo {
namespace {

TEST(DatabaseNameTest, MultitenancySupportDisabled) {
    DatabaseName dbnWithoutTenant1 = DatabaseName::createDatabaseName_forTest(boost::none, "a");

    ASSERT(!dbnWithoutTenant1.tenantId());
    ASSERT_EQUALS(std::string("a"), dbnWithoutTenant1.toString_forTest());

    TenantId tenantId(OID::gen());
    DatabaseName dbnWithTenant = DatabaseName::createDatabaseName_forTest(tenantId, "a");
    ASSERT(dbnWithTenant.tenantId());
    ASSERT_EQUALS(tenantId, *dbnWithTenant.tenantId());
    ASSERT_EQUALS(std::string("a"), dbnWithoutTenant1.toString_forTest());
    ASSERT_EQUALS(std::string(tenantId.toString() + "_a"),
                  dbnWithTenant.toStringWithTenantId_forTest());
}

TEST(DatabaseNameTest, MultitenancySupportEnabledTenantIDNotRequired) {
    // TODO SERVER-62114 remove this test case.
    RAIIServerParameterControllerForTest multitenancyController("multitenancySupport", true);

    DatabaseName dbnWithoutTenant = DatabaseName::createDatabaseName_forTest(boost::none, "a");
    ASSERT(!dbnWithoutTenant.tenantId());
    ASSERT_EQUALS(std::string("a"), dbnWithoutTenant.toString_forTest());

    TenantId tenantId(OID::gen());
    DatabaseName dbnWithTenant = DatabaseName::createDatabaseName_forTest(tenantId, "a");
    ASSERT(dbnWithTenant.tenantId());
    ASSERT_EQUALS(tenantId, *dbnWithTenant.tenantId());
    ASSERT_EQUALS(std::string("a"), dbnWithTenant.toString_forTest());
    ASSERT_EQUALS(std::string(tenantId.toString() + "_a"),
                  dbnWithTenant.toStringWithTenantId_forTest());
}

TEST(DatabaseNameTest, VerifyEqualsOperator) {
    TenantId tenantId(OID::gen());
    DatabaseName dbn = DatabaseName::createDatabaseName_forTest(tenantId, "a");
    ASSERT_TRUE(DatabaseName::createDatabaseName_forTest(tenantId, "a") == dbn);
    ASSERT_TRUE(DatabaseName::createDatabaseName_forTest(tenantId, "b") != dbn);

    TenantId otherTenantId = TenantId(OID::gen());
    ASSERT_TRUE(DatabaseName::createDatabaseName_forTest(otherTenantId, "a") != dbn);
    ASSERT_TRUE(DatabaseName::createDatabaseName_forTest(boost::none, "a") != dbn);
}

TEST(DatabaseNameTest, VerifyHashFunction) {
    TenantId tenantId1(OID::gen());
    TenantId tenantId2(OID::gen());
    DatabaseName dbn1 = DatabaseName::createDatabaseName_forTest(tenantId1, "a");
    DatabaseName dbn2 = DatabaseName::createDatabaseName_forTest(tenantId2, "a");
    DatabaseName dbn3 = DatabaseName::createDatabaseName_forTest(boost::none, "a");

    stdx::unordered_map<DatabaseName, std::string> dbMap;

    dbMap[dbn1] = "value T1 a1";
    ASSERT_EQUALS(dbMap[dbn1], "value T1 a1");
    dbMap[dbn1] = "value T1 a2";
    ASSERT_EQUALS(dbMap[dbn1], "value T1 a2");
    dbMap[DatabaseName::createDatabaseName_forTest(tenantId1, "a")] = "value T1 a3";
    ASSERT_EQUALS(dbMap[dbn1], "value T1 a3");

    dbMap[dbn2] = "value T2 a1";
    ASSERT_EQUALS(dbMap[dbn2], "value T2 a1");
    dbMap[dbn2] = "value T2 a2";

    dbMap[dbn3] = "value no tenant a1";
    ASSERT_EQUALS(dbMap[dbn3], "value no tenant a1");
    dbMap[dbn3] = "value no tenant a2";

    // verify all key-value in map to ensure all data is correct.
    ASSERT_EQUALS(dbMap[dbn1], "value T1 a3");
    ASSERT_EQUALS(dbMap[dbn2], "value T2 a2");
    ASSERT_EQUALS(dbMap[dbn3], "value no tenant a2");
}

TEST(DatabaseNameTest, VerifyCompareFunction) {
    TenantId tenantId1 = TenantId(OID::gen());
    TenantId tenantId2 = TenantId(OID::gen());

    // OID's generated by the same process are monotonically increasing.
    ASSERT(tenantId1 < tenantId2);

    DatabaseName dbn1a = DatabaseName::createDatabaseName_forTest(tenantId1, "a");
    DatabaseName dbn1A = DatabaseName::createDatabaseName_forTest(tenantId1, "A");
    DatabaseName dbn1b = DatabaseName::createDatabaseName_forTest(tenantId1, "b");
    DatabaseName dbn2a = DatabaseName::createDatabaseName_forTest(tenantId2, "a");
    DatabaseName dbn3a = DatabaseName::createDatabaseName_forTest(boost::none, "a");
    DatabaseName dbn3A = DatabaseName::createDatabaseName_forTest(boost::none, "a");

    ASSERT_LT(dbn1a, dbn1b);
    ASSERT_LT(dbn1b, dbn2a);
    ASSERT_NE(dbn3a, dbn1a);
    ASSERT_NE(dbn1a, dbn2a);
    ASSERT_LT(dbn3a, dbn1a);
    ASSERT_LT(dbn3a, dbn2a);
    ASSERT_GT(dbn2a, dbn1a);
    ASSERT_TRUE(dbn1a.equalCaseInsensitive(dbn1a));
    ASSERT_TRUE(dbn1a.equalCaseInsensitive(dbn1A));
    ASSERT_FALSE(dbn1a.equalCaseInsensitive(dbn2a));
    ASSERT_FALSE(dbn1a.equalCaseInsensitive(dbn3a));
    ASSERT_TRUE(dbn3a.equalCaseInsensitive(dbn3A));
}

TEST(DatabaseNameTest, DatabaseValidNames) {
    ASSERT(DatabaseName::validDBName("foo", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(DatabaseName::validDBName("foo$bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo/bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo.bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo\\bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo\"bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("a\0b"_sd, DatabaseName::DollarInDbNameBehavior::Allow));
#ifdef _WIN32
    ASSERT(!DatabaseName::validDBName("foo*bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo<bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo>bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo:bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo|bar", DatabaseName::DollarInDbNameBehavior::Allow));
    ASSERT(!DatabaseName::validDBName("foo?bar", DatabaseName::DollarInDbNameBehavior::Allow));
#endif

    ASSERT(DatabaseName::validDBName("foo"));
    ASSERT(!DatabaseName::validDBName("foo$bar"));
    ASSERT(!DatabaseName::validDBName("foo/bar"));
    ASSERT(!DatabaseName::validDBName("foo bar"));
    ASSERT(!DatabaseName::validDBName("foo.bar"));
    ASSERT(!DatabaseName::validDBName("foo\\bar"));
    ASSERT(!DatabaseName::validDBName("foo\"bar"));
    ASSERT(!DatabaseName::validDBName("a\0b"_sd));
#ifdef _WIN32
    ASSERT(!DatabaseName::validDBName("foo*bar"));
    ASSERT(!DatabaseName::validDBName("foo<bar"));
    ASSERT(!DatabaseName::validDBName("foo>bar"));
    ASSERT(!DatabaseName::validDBName("foo:bar"));
    ASSERT(!DatabaseName::validDBName("foo|bar"));
    ASSERT(!DatabaseName::validDBName("foo?bar"));
#endif

    ASSERT(DatabaseName::validDBName(
        "ThisIsADatabaseNameThatBrokeAllRecordsForValidLengthForDBName63"));
    ASSERT(!DatabaseName::validDBName(
        "WhileThisDatabaseNameExceedsTheMaximumLengthForDatabaseNamesof63"));
}

TEST(DatabaseNameTest, CheckDatabaseNameLogAttrs) {
    TenantId tenantId(OID::gen());
    DatabaseName dbWithTenant = DatabaseName::createDatabaseName_forTest(tenantId, "myLongDbName");
    startCapturingLogMessages();
    LOGV2(7448500, "Msg db:", logAttrs(dbWithTenant));

    ASSERT_EQUALS(1,
                  countBSONFormatLogLinesIsSubset(
                      BSON("attr" << BSON("db" << dbWithTenant.toStringWithTenantId_forTest()))));

    LOGV2(7448501, "Msg database:", "database"_attr = dbWithTenant);
    ASSERT_EQUALS(1,
                  countBSONFormatLogLinesIsSubset(BSON(
                      "attr" << BSON("database" << dbWithTenant.toStringWithTenantId_forTest()))));
    stopCapturingLogMessages();
}

TEST(DatabaseNameTest, EmptyDbString) {
    DatabaseName empty{};
    ASSERT_FALSE(empty.tenantId());
    ASSERT_EQ(empty.toString_forTest(), "");
    ASSERT_EQ(empty.toStringWithTenantId_forTest(), "");

    DatabaseName emptyFromStringData =
        DatabaseName::createDatabaseName_forTest(boost::none, StringData());
    ASSERT_FALSE(emptyFromStringData.tenantId());
    ASSERT_EQ(emptyFromStringData.toString_forTest(), "");
    ASSERT_EQ(emptyFromStringData.toStringWithTenantId_forTest(), "");

    TenantId tenantId(OID::gen());
    DatabaseName emptyWithTenantId = DatabaseName::createDatabaseName_forTest(tenantId, "");
    ASSERT(emptyWithTenantId.tenantId());
    ASSERT_EQ(emptyWithTenantId.toString_forTest(), "");
    ASSERT_EQ(emptyWithTenantId.toStringWithTenantId_forTest(),
              fmt::format("{}_", tenantId.toString()));
}

TEST(DatabaseNameTest, FromDataEquality) {
    NamespaceString test = NamespaceString::createNamespaceString_forTest("foo");
    ASSERT_EQ(test.dbName(), DatabaseName::createDatabaseName_forTest(boost::none, "foo"));
    NamespaceString testTwo{DatabaseName::createDatabaseName_forTest(boost::none, "foo")};
    ASSERT_EQ(testTwo.dbName(), DatabaseName::createDatabaseName_forTest(boost::none, "foo"));
}

TEST(DatabaseNameTest, Size) {
    const std::string kMaxSizeDb(DatabaseName::kMaxDatabaseNameLength, 'a');

    const auto checkDbSize = [](std::vector<std::string> dbs, boost::optional<TenantId> tenantId) {
        for (size_t i = 0; i < dbs.size(); i++) {
            const auto dbName = DatabaseName::createDatabaseName_forTest(tenantId, dbs[i]);
            ASSERT_EQ(dbName.size(), dbs[i].size());
        }
    };

    checkDbSize({"", "myDb", kMaxSizeDb}, boost::none);
    checkDbSize({"", "myDb", kMaxSizeDb}, TenantId(OID::gen()));
}
}  // namespace
}  // namespace mongo