// Copyright 2010-2020, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef NO_USAGE_REWRITER
#include "rewriter/usage_rewriter.h"
#include <memory>
#include <string>
#include "base/system_util.h"
#include "config/config_handler.h"
#include "converter/segments.h"
#include "data_manager/testing/mock_data_manager.h"
#include "dictionary/pos_matcher.h"
#include "dictionary/suppression_dictionary.h"
#include "dictionary/user_dictionary.h"
#include "dictionary/user_dictionary_storage.h"
#include "dictionary/user_pos.h"
#include "protocol/commands.pb.h"
#include "protocol/config.pb.h"
#include "request/conversion_request.h"
#include "testing/base/public/googletest.h"
#include "testing/base/public/gunit.h"
namespace mozc {
namespace {
using dictionary::SuppressionDictionary;
using dictionary::UserDictionary;
using dictionary::UserPOS;
void AddCandidate(const std::string &key, const std::string &value,
const std::string &content_key,
const std::string &content_value, Segment *segment) {
Segment::Candidate *candidate = segment->add_candidate();
candidate->Init();
candidate->key = key;
candidate->value = value;
candidate->content_key = content_key;
candidate->content_value = content_value;
}
} // namespace
class UsageRewriterTest : public ::testing::Test {
protected:
UsageRewriterTest() {
convreq_.set_request(&request_);
convreq_.set_config(&config_);
}
void SetUp() override {
SystemUtil::SetUserProfileDirectory(FLAGS_test_tmpdir);
config::ConfigHandler::GetDefaultConfig(&config_);
data_manager_.reset(new testing::MockDataManager);
pos_matcher_.Set(data_manager_->GetPOSMatcherData());
suppression_dictionary_.reset(new SuppressionDictionary);
user_dictionary_.reset(
new UserDictionary(UserPOS::CreateFromDataManager(*data_manager_),
pos_matcher_, suppression_dictionary_.get()));
}
void TearDown() override {
// just in case, reset the config
config::ConfigHandler::GetDefaultConfig(&config_);
}
UsageRewriter *CreateUsageRewriter() const {
return new UsageRewriter(data_manager_.get(), user_dictionary_.get());
}
ConversionRequest convreq_;
commands::Request request_;
config::Config config_;
std::unique_ptr<SuppressionDictionary> suppression_dictionary_;
std::unique_ptr<UserDictionary> user_dictionary_;
std::unique_ptr<testing::MockDataManager> data_manager_;
dictionary::POSMatcher pos_matcher_;
};
TEST_F(UsageRewriterTest, CapabilityTest) {
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
EXPECT_EQ(RewriterInterface::CONVERSION | RewriterInterface::PREDICTION,
rewriter->capability(convreq_));
}
TEST_F(UsageRewriterTest, ConjugationTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("うたえば");
AddCandidate("うたえば", "歌えば", "うたえ", "歌え", seg);
AddCandidate("うたえば", "唱えば", "うたえ", "唄え", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("歌う", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("唄う", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(1).usage_description);
}
TEST_F(UsageRewriterTest, SingleSegmentSingleCandidateTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("青い", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "あああ", "あおい", "あああ", seg);
EXPECT_FALSE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_description);
}
TEST_F(UsageRewriterTest, ConfigTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
// Default setting
{
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
}
{
config_.mutable_information_list_config()->set_use_local_usage_dictionary(
false);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
EXPECT_FALSE(rewriter->Rewrite(convreq_, &segments));
}
{
config_.mutable_information_list_config()->set_use_local_usage_dictionary(
true);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
}
}
TEST_F(UsageRewriterTest, SingleSegmentMultiCandidatesTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
AddCandidate("あおい", "蒼い", "あおい", "蒼い", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("青い", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("蒼い", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(1).usage_description);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "青い", "あおい", "青い", seg);
AddCandidate("あおい", "あああ", "あおい", "あああ", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("青い", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(1).usage_description);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "あああ", "あおい", "あああ", seg);
AddCandidate("あおい", "青い", "あおい", "青い", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("青い", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(1).usage_description);
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおい");
AddCandidate("あおい", "あああ", "あおい", "あああ", seg);
AddCandidate("あおい", "いいい", "あおい", "いいい", seg);
EXPECT_FALSE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(1).usage_description);
}
TEST_F(UsageRewriterTest, MultiSegmentsTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
segments.Clear();
seg = segments.push_back_segment();
seg->set_key("あおく");
AddCandidate("あおく", "青く", "あおく", "青く", seg);
AddCandidate("あおく", "蒼く", "あおく", "蒼く", seg);
AddCandidate("あおく", "アオク", "あおく", "アオク", seg);
seg = segments.push_back_segment();
seg->set_key("うたえば");
AddCandidate("うたえば", "歌えば", "うたえ", "歌え", seg);
AddCandidate("うたえば", "唱えば", "うたえ", "唄え", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("青い", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("蒼い", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(1).usage_description);
EXPECT_EQ("", segments.conversion_segment(0).candidate(2).usage_title);
EXPECT_EQ("", segments.conversion_segment(0).candidate(2).usage_description);
EXPECT_EQ("歌う", segments.conversion_segment(1).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(1).candidate(0).usage_description);
EXPECT_EQ("唄う", segments.conversion_segment(1).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(1).candidate(1).usage_description);
}
TEST_F(UsageRewriterTest, SameUsageTest) {
Segments segments;
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
Segment *seg;
seg = segments.push_back_segment();
seg->set_key("うたえば");
AddCandidate("うたえば", "歌えば", "うたえ", "歌え", seg);
AddCandidate("うたえば", "唱えば", "うたえ", "唄え", seg);
AddCandidate("うたえば", "唱エバ", "うたえ", "唄え", seg);
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
EXPECT_EQ("歌う", segments.conversion_segment(0).candidate(0).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(0).usage_description);
EXPECT_EQ("唄う", segments.conversion_segment(0).candidate(1).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(1).usage_description);
EXPECT_EQ("唄う", segments.conversion_segment(0).candidate(2).usage_title);
EXPECT_NE("", segments.conversion_segment(0).candidate(2).usage_description);
EXPECT_NE(segments.conversion_segment(0).candidate(0).usage_id,
segments.conversion_segment(0).candidate(1).usage_id);
EXPECT_EQ(segments.conversion_segment(0).candidate(1).usage_id,
segments.conversion_segment(0).candidate(2).usage_id);
}
TEST_F(UsageRewriterTest, GetKanjiPrefixAndOneHiragana) {
EXPECT_EQ("合わ", UsageRewriter::GetKanjiPrefixAndOneHiragana("合わせる"));
EXPECT_EQ("合う", UsageRewriter::GetKanjiPrefixAndOneHiragana("合う"));
EXPECT_EQ("合合わ",
UsageRewriter::GetKanjiPrefixAndOneHiragana("合合わせる"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("合"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("京都"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("合合合わせる"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("カタカナ"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("abc"));
EXPECT_EQ("", UsageRewriter::GetKanjiPrefixAndOneHiragana("あ合わせる"));
}
TEST_F(UsageRewriterTest, CommentFromUserDictionary) {
// Load mock data
{
UserDictionaryStorage storage("");
UserDictionaryStorage::UserDictionary *dic =
storage.GetProto().add_dictionaries();
UserDictionaryStorage::UserDictionaryEntry *entry = dic->add_entries();
entry->set_key("うま");
entry->set_value("アルパカ");
entry->set_pos(user_dictionary::UserDictionary::NOUN);
entry->set_comment("アルパカコメント");
user_dictionary_->Load(storage.GetProto());
}
// Emulates the conversion of key="うま".
Segments segments;
segments.Clear();
Segment *seg = segments.push_back_segment();
seg->set_key("うま");
AddCandidate("うま", "Horse", "うま", "Horse", seg);
AddCandidate("うま", "アルパカ", "うま", "アルパカ", seg);
std::unique_ptr<UsageRewriter> rewriter(CreateUsageRewriter());
EXPECT_TRUE(rewriter->Rewrite(convreq_, &segments));
// Result of ("うま", "Horse"). No comment is expected.
const Segment::Candidate &cand0 = segments.conversion_segment(0).candidate(0);
EXPECT_TRUE(cand0.usage_title.empty());
EXPECT_TRUE(cand0.usage_description.empty());
// Result of ("うま", "アルパカ"). Comment from user dictionary is expected.
const Segment::Candidate &cand1 = segments.conversion_segment(0).candidate(1);
EXPECT_EQ("アルパカ", cand1.usage_title);
EXPECT_EQ("アルパカコメント", cand1.usage_description);
}
} // namespace mozc
#endif // NO_USAGE_REWRITER