| /* |
| * Copyright (C) 2015, 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. |
| */ |
| |
| #include <memory> |
| #include <set> |
| #include <string> |
| #include <vector> |
| |
| #include <android-base/stringprintf.h> |
| #include <gtest/gtest.h> |
| |
| #include "aidl.h" |
| #include "aidl_language.h" |
| #include "tests/fake_io_delegate.h" |
| #include "type_cpp.h" |
| #include "type_java.h" |
| #include "type_namespace.h" |
| |
| using android::aidl::test::FakeIoDelegate; |
| using android::base::StringPrintf; |
| using std::set; |
| using std::string; |
| using std::unique_ptr; |
| using std::vector; |
| using android::aidl::internals::parse_preprocessed_file; |
| |
| namespace android { |
| namespace aidl { |
| namespace { |
| |
| const char kExpectedDepFileContents[] = |
| R"(place/for/output/p/IFoo.java : \ |
| p/IFoo.aidl |
| |
| p/IFoo.aidl : |
| )"; |
| |
| const char kExpectedNinjaDepFileContents[] = |
| R"(place/for/output/p/IFoo.java : \ |
| p/IFoo.aidl |
| )"; |
| |
| const char kExpectedParcelableDepFileContents[] = |
| R"( : \ |
| p/Foo.aidl |
| |
| p/Foo.aidl : |
| )"; |
| |
| } // namespace |
| |
| class AidlTest : public ::testing::Test { |
| protected: |
| void SetUp() override { |
| java_types_.Init(); |
| cpp_types_.Init(); |
| } |
| |
| unique_ptr<AidlInterface> Parse(const string& path, |
| const string& contents, |
| TypeNamespace* types, |
| AidlError* error = nullptr) { |
| io_delegate_.SetFileContents(path, contents); |
| unique_ptr<AidlInterface> ret; |
| std::vector<std::unique_ptr<AidlImport>> imports; |
| AidlError actual_error = ::android::aidl::internals::load_and_validate_aidl( |
| preprocessed_files_, |
| import_paths_, |
| path, |
| io_delegate_, |
| types, |
| &ret, |
| &imports); |
| if (error != nullptr) { |
| *error = actual_error; |
| } |
| return ret; |
| } |
| |
| FakeIoDelegate io_delegate_; |
| vector<string> preprocessed_files_; |
| vector<string> import_paths_; |
| java::JavaTypeNamespace java_types_; |
| cpp::TypeNamespace cpp_types_; |
| }; |
| |
| TEST_F(AidlTest, JavaAcceptsMissingPackage) { |
| EXPECT_NE(nullptr, Parse("IFoo.aidl", "interface IFoo { }", &java_types_)); |
| } |
| |
| TEST_F(AidlTest, RejectsArraysOfBinders) { |
| import_paths_.push_back(""); |
| io_delegate_.SetFileContents("bar/IBar.aidl", |
| "package bar; interface IBar {}"); |
| string path = "foo/IFoo.aidl"; |
| string contents = "package foo;\n" |
| "import bar.IBar;\n" |
| "interface IFoo { void f(in IBar[] input); }"; |
| EXPECT_EQ(nullptr, Parse(path, contents, &java_types_)); |
| EXPECT_EQ(nullptr, Parse(path, contents, &cpp_types_)); |
| } |
| |
| TEST_F(AidlTest, CppRejectsMissingPackage) { |
| EXPECT_EQ(nullptr, Parse("IFoo.aidl", "interface IFoo { }", &cpp_types_)); |
| EXPECT_NE(nullptr, |
| Parse("a/IFoo.aidl", "package a; interface IFoo { }", &cpp_types_)); |
| } |
| |
| TEST_F(AidlTest, RejectsOnewayOutParameters) { |
| string oneway_interface = |
| "package a; oneway interface IFoo { void f(out int bar); }"; |
| string oneway_method = |
| "package a; interface IBar { oneway void f(out int bar); }"; |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_interface, &cpp_types_)); |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_interface, &java_types_)); |
| EXPECT_EQ(nullptr, Parse("a/IBar.aidl", oneway_method, &cpp_types_)); |
| EXPECT_EQ(nullptr, Parse("a/IBar.aidl", oneway_method, &java_types_)); |
| } |
| |
| TEST_F(AidlTest, RejectsOnewayNonVoidReturn) { |
| string oneway_method = "package a; interface IFoo { oneway int f(); }"; |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_method, &cpp_types_)); |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_method, &java_types_)); |
| } |
| |
| TEST_F(AidlTest, RejectsNullablePrimitive) { |
| string oneway_method = "package a; interface IFoo { @nullable int f(); }"; |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_method, &cpp_types_)); |
| EXPECT_EQ(nullptr, Parse("a/IFoo.aidl", oneway_method, &java_types_)); |
| } |
| |
| TEST_F(AidlTest, ParsesNullableAnnotation) { |
| for (auto is_nullable: {true, false}) { |
| auto parse_result = Parse( |
| "a/IFoo.aidl", |
| StringPrintf( "package a; interface IFoo {%s String f(); }", |
| (is_nullable) ? "@nullable" : ""), |
| &cpp_types_); |
| ASSERT_NE(nullptr, parse_result); |
| ASSERT_FALSE(parse_result->GetMethods().empty()); |
| EXPECT_EQ(parse_result->GetMethods()[0]->GetType().IsNullable(), |
| is_nullable); |
| } |
| } |
| |
| TEST_F(AidlTest, ParsesUtf8Annotations) { |
| for (auto is_utf8: {true, false}) { |
| auto parse_result = Parse( |
| "a/IFoo.aidl", |
| StringPrintf( "package a; interface IFoo {%s String f(); }", |
| (is_utf8) ? "@utf8InCpp" : ""), |
| &cpp_types_); |
| ASSERT_NE(nullptr, parse_result); |
| ASSERT_FALSE(parse_result->GetMethods().empty()); |
| EXPECT_EQ(parse_result->GetMethods()[0]->GetType().IsUtf8InCpp(), |
| is_utf8); |
| } |
| } |
| |
| TEST_F(AidlTest, AcceptsOneway) { |
| string oneway_method = "package a; interface IFoo { oneway void f(int a); }"; |
| string oneway_interface = |
| "package a; oneway interface IBar { void f(int a); }"; |
| EXPECT_NE(nullptr, Parse("a/IFoo.aidl", oneway_method, &cpp_types_)); |
| EXPECT_NE(nullptr, Parse("a/IFoo.aidl", oneway_method, &java_types_)); |
| EXPECT_NE(nullptr, Parse("a/IBar.aidl", oneway_interface, &cpp_types_)); |
| EXPECT_NE(nullptr, Parse("a/IBar.aidl", oneway_interface, &java_types_)); |
| } |
| |
| TEST_F(AidlTest, ParsesPreprocessedFile) { |
| string simple_content = "parcelable a.Foo;\ninterface b.IBar;"; |
| io_delegate_.SetFileContents("path", simple_content); |
| EXPECT_FALSE(java_types_.HasTypeByCanonicalName("a.Foo")); |
| EXPECT_TRUE(parse_preprocessed_file(io_delegate_, "path", &java_types_)); |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("a.Foo")); |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("b.IBar")); |
| } |
| |
| TEST_F(AidlTest, ParsesPreprocessedFileWithWhitespace) { |
| string simple_content = "parcelable a.Foo;\n interface b.IBar ;\t"; |
| io_delegate_.SetFileContents("path", simple_content); |
| EXPECT_FALSE(java_types_.HasTypeByCanonicalName("a.Foo")); |
| EXPECT_TRUE(parse_preprocessed_file(io_delegate_, "path", &java_types_)); |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("a.Foo")); |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("b.IBar")); |
| } |
| |
| TEST_F(AidlTest, PreferImportToPreprocessed) { |
| io_delegate_.SetFileContents("preprocessed", "interface another.IBar;"); |
| io_delegate_.SetFileContents("one/IBar.aidl", "package one; " |
| "interface IBar {}"); |
| preprocessed_files_.push_back("preprocessed"); |
| import_paths_.push_back(""); |
| auto parse_result = Parse( |
| "p/IFoo.aidl", "package p; import one.IBar; interface IFoo {}", |
| &java_types_); |
| EXPECT_NE(nullptr, parse_result); |
| // We expect to know about both kinds of IBar |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("one.IBar")); |
| EXPECT_TRUE(java_types_.HasTypeByCanonicalName("another.IBar")); |
| // But if we request just "IBar" we should get our imported one. |
| AidlType ambiguous_type("IBar", 0, "", false /* not an array */); |
| const java::Type* type = java_types_.Find(ambiguous_type); |
| ASSERT_TRUE(type); |
| EXPECT_EQ("one.IBar", type->CanonicalName()); |
| } |
| |
| TEST_F(AidlTest, WritePreprocessedFile) { |
| io_delegate_.SetFileContents("p/Outer.aidl", |
| "package p; parcelable Outer.Inner;"); |
| io_delegate_.SetFileContents("one/IBar.aidl", "package one; import p.Outer;" |
| "interface IBar {}"); |
| |
| JavaOptions options; |
| options.output_file_name_ = "preprocessed"; |
| options.files_to_preprocess_.resize(2); |
| options.files_to_preprocess_[0] = "p/Outer.aidl"; |
| options.files_to_preprocess_[1] = "one/IBar.aidl"; |
| EXPECT_TRUE(::android::aidl::preprocess_aidl(options, io_delegate_)); |
| |
| string output; |
| EXPECT_TRUE(io_delegate_.GetWrittenContents("preprocessed", &output)); |
| EXPECT_EQ("parcelable p.Outer.Inner;\ninterface one.IBar;\n", output); |
| } |
| |
| TEST_F(AidlTest, RequireOuterClass) { |
| io_delegate_.SetFileContents("p/Outer.aidl", |
| "package p; parcelable Outer.Inner;"); |
| import_paths_.push_back(""); |
| auto parse_result = Parse( |
| "p/IFoo.aidl", |
| "package p; import p.Outer; interface IFoo { void f(in Inner c); }", |
| &java_types_); |
| EXPECT_EQ(nullptr, parse_result); |
| } |
| |
| TEST_F(AidlTest, ParseCompoundParcelableFromPreprocess) { |
| io_delegate_.SetFileContents("preprocessed", |
| "parcelable p.Outer.Inner;"); |
| preprocessed_files_.push_back("preprocessed"); |
| auto parse_result = Parse( |
| "p/IFoo.aidl", |
| "package p; interface IFoo { void f(in Inner c); }", |
| &java_types_); |
| // TODO(wiley): This should actually return nullptr because we require |
| // the outer class name. However, for legacy reasons, |
| // this behavior must be maintained. b/17415692 |
| EXPECT_NE(nullptr, parse_result); |
| } |
| |
| TEST_F(AidlTest, FailOnParcelable) { |
| JavaOptions options; |
| options.input_file_name_ = "p/IFoo.aidl"; |
| io_delegate_.SetFileContents(options.input_file_name_, |
| "package p; parcelable IFoo;"); |
| // By default, we shouldn't fail on parcelable. |
| EXPECT_EQ(0, ::android::aidl::compile_aidl_to_java(options, io_delegate_)); |
| options.fail_on_parcelable_ = true; |
| EXPECT_NE(0, ::android::aidl::compile_aidl_to_java(options, io_delegate_)); |
| } |
| |
| TEST_F(AidlTest, FailOnDuplicateConstantNames) { |
| AidlError reported_error; |
| EXPECT_EQ(nullptr, |
| Parse("p/IFoo.aidl", |
| R"(package p; |
| interface IFoo { |
| const String DUPLICATED = "d"; |
| const int DUPLICATED = 1; |
| } |
| )", |
| &cpp_types_, |
| &reported_error)); |
| EXPECT_EQ(AidlError::BAD_CONSTANTS, reported_error); |
| } |
| |
| TEST_F(AidlTest, FailOnMalformedConstHexValue) { |
| AidlError reported_error; |
| EXPECT_EQ(nullptr, |
| Parse("p/IFoo.aidl", |
| R"(package p; |
| interface IFoo { |
| const int BAD_HEX_VALUE = 0xffffffffffffffffff; |
| } |
| )", |
| &cpp_types_, |
| &reported_error)); |
| EXPECT_EQ(AidlError::BAD_CONSTANTS, reported_error); |
| } |
| |
| TEST_F(AidlTest, ParsePositiveConstHexValue) { |
| AidlError reported_error; |
| auto cpp_parse_result = |
| Parse("p/IFoo.aidl", |
| R"(package p; |
| interface IFoo { |
| const int POSITIVE_HEX_VALUE = 0xf5; |
| } |
| )", |
| &cpp_types_, |
| &reported_error); |
| EXPECT_NE(nullptr, cpp_parse_result); |
| const auto& cpp_int_constants = cpp_parse_result->GetIntConstants(); |
| EXPECT_EQ((size_t)1, cpp_int_constants.size()); |
| EXPECT_EQ("POSITIVE_HEX_VALUE", cpp_int_constants[0]->GetName()); |
| EXPECT_EQ(245, cpp_int_constants[0]->GetValue()); |
| } |
| |
| TEST_F(AidlTest, ParseNegativeConstHexValue) { |
| AidlError reported_error; |
| auto cpp_parse_result = |
| Parse("p/IFoo.aidl", |
| R"(package p; |
| interface IFoo { |
| const int NEGATIVE_HEX_VALUE = 0xffffffff; |
| } |
| )", |
| &cpp_types_, |
| &reported_error); |
| EXPECT_NE(nullptr, cpp_parse_result); |
| const auto& cpp_int_constants = cpp_parse_result->GetIntConstants(); |
| EXPECT_EQ((size_t)1, cpp_int_constants.size()); |
| EXPECT_EQ("NEGATIVE_HEX_VALUE", cpp_int_constants[0]->GetName()); |
| EXPECT_EQ(-1, cpp_int_constants[0]->GetValue()); |
| } |
| |
| TEST_F(AidlTest, UnderstandsNestedParcelables) { |
| io_delegate_.SetFileContents( |
| "p/Outer.aidl", |
| "package p; parcelable Outer.Inner cpp_header \"baz/header\";"); |
| import_paths_.push_back(""); |
| const string input_path = "p/IFoo.aidl"; |
| const string input = "package p; import p.Outer; interface IFoo" |
| " { Outer.Inner get(); }"; |
| |
| auto cpp_parse_result = Parse(input_path, input, &cpp_types_); |
| EXPECT_NE(nullptr, cpp_parse_result); |
| auto cpp_type = cpp_types_.FindTypeByCanonicalName("p.Outer.Inner"); |
| ASSERT_NE(nullptr, cpp_type); |
| // C++ uses "::" instead of "." to refer to a inner class. |
| EXPECT_EQ("::p::Outer::Inner", cpp_type->CppType()); |
| } |
| |
| TEST_F(AidlTest, UnderstandsNativeParcelables) { |
| io_delegate_.SetFileContents( |
| "p/Bar.aidl", |
| "package p; parcelable Bar cpp_header \"baz/header\";"); |
| import_paths_.push_back(""); |
| const string input_path = "p/IFoo.aidl"; |
| const string input = "package p; import p.Bar; interface IFoo { }"; |
| |
| // C++ understands C++ specific stuff |
| auto cpp_parse_result = Parse(input_path, input, &cpp_types_); |
| EXPECT_NE(nullptr, cpp_parse_result); |
| auto cpp_type = cpp_types_.FindTypeByCanonicalName("p.Bar"); |
| ASSERT_NE(nullptr, cpp_type); |
| EXPECT_EQ("::p::Bar", cpp_type->CppType()); |
| set<string> headers; |
| cpp_type->GetHeaders(&headers); |
| EXPECT_EQ(1u, headers.size()); |
| EXPECT_EQ(1u, headers.count("baz/header")); |
| |
| // Java ignores C++ specific stuff |
| auto java_parse_result = Parse(input_path, input, &java_types_); |
| EXPECT_NE(nullptr, java_parse_result); |
| auto java_type = java_types_.FindTypeByCanonicalName("p.Bar"); |
| ASSERT_NE(nullptr, java_type); |
| EXPECT_EQ("p.Bar", java_type->InstantiableName()); |
| } |
| |
| TEST_F(AidlTest, WritesCorrectDependencyFile) { |
| // While the in tree build system always gives us an output file name, |
| // other android tools take advantage of our ability to infer the intended |
| // file name. This test makes sure we handle this correctly. |
| JavaOptions options; |
| options.input_file_name_ = "p/IFoo.aidl"; |
| options.output_base_folder_ = "place/for/output"; |
| options.dep_file_name_ = "dep/file/path"; |
| io_delegate_.SetFileContents(options.input_file_name_, |
| "package p; interface IFoo {}"); |
| EXPECT_EQ(0, ::android::aidl::compile_aidl_to_java(options, io_delegate_)); |
| string actual_dep_file_contents; |
| EXPECT_TRUE(io_delegate_.GetWrittenContents(options.dep_file_name_, |
| &actual_dep_file_contents)); |
| EXPECT_EQ(actual_dep_file_contents, kExpectedDepFileContents); |
| } |
| |
| TEST_F(AidlTest, WritesCorrectDependencyFileNinja) { |
| // While the in tree build system always gives us an output file name, |
| // other android tools take advantage of our ability to infer the intended |
| // file name. This test makes sure we handle this correctly. |
| JavaOptions options; |
| options.input_file_name_ = "p/IFoo.aidl"; |
| options.output_base_folder_ = "place/for/output"; |
| options.dep_file_name_ = "dep/file/path"; |
| options.dep_file_ninja_ = true; |
| io_delegate_.SetFileContents(options.input_file_name_, |
| "package p; interface IFoo {}"); |
| EXPECT_EQ(0, ::android::aidl::compile_aidl_to_java(options, io_delegate_)); |
| string actual_dep_file_contents; |
| EXPECT_TRUE(io_delegate_.GetWrittenContents(options.dep_file_name_, |
| &actual_dep_file_contents)); |
| EXPECT_EQ(actual_dep_file_contents, kExpectedNinjaDepFileContents); |
| } |
| |
| TEST_F(AidlTest, WritesTrivialDependencyFileForParcelable) { |
| // The SDK uses aidl to decide whether a .aidl file is a parcelable. It does |
| // this by calling aidl with every .aidl file it finds, then parsing the |
| // generated dependency files. Those that reference .java output files are |
| // for interfaces and those that do not are parcelables. However, for both |
| // parcelables and interfaces, we *must* generate a non-empty dependency file. |
| JavaOptions options; |
| options.input_file_name_ = "p/Foo.aidl"; |
| options.output_base_folder_ = "place/for/output"; |
| options.dep_file_name_ = "dep/file/path"; |
| io_delegate_.SetFileContents(options.input_file_name_, |
| "package p; parcelable Foo;"); |
| EXPECT_EQ(0, ::android::aidl::compile_aidl_to_java(options, io_delegate_)); |
| string actual_dep_file_contents; |
| EXPECT_TRUE(io_delegate_.GetWrittenContents(options.dep_file_name_, |
| &actual_dep_file_contents)); |
| EXPECT_EQ(actual_dep_file_contents, kExpectedParcelableDepFileContents); |
| } |
| |
| } // namespace aidl |
| } // namespace android |