tools/aapt2/flatten/XmlFlattener_test.cpp

/*
 * 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 "flatten/XmlFlattener.h"

#include "androidfw/ResourceTypes.h"

#include "link/Linkers.h"
#include "test/Test.h"
#include "util/BigBuffer.h"
#include "util/Util.h"

namespace aapt {

class XmlFlattenerTest : public ::testing::Test {
 public:
  void SetUp() override {
    context_ =
        test::ContextBuilder()
            .SetCompilationPackage("com.app.test")
            .SetNameManglerPolicy(NameManglerPolicy{"com.app.test"})
            .AddSymbolSource(
                test::StaticSymbolSourceBuilder()
                    .AddSymbol("android:attr/id", ResourceId(0x010100d0),
                               test::AttributeBuilder().Build())
                    .AddSymbol("com.app.test:id/id", ResourceId(0x7f020000))
                    .AddSymbol("android:attr/paddingStart",
                               ResourceId(0x010103b3),
                               test::AttributeBuilder().Build())
                    .AddSymbol("android:attr/colorAccent",
                               ResourceId(0x01010435),
                               test::AttributeBuilder().Build())
                    .Build())
            .Build();
  }

  ::testing::AssertionResult Flatten(xml::XmlResource* doc,
                                     android::ResXMLTree* out_tree,
                                     const XmlFlattenerOptions& options = {}) {
    using namespace android;  // For NO_ERROR on windows because it is a macro.

    BigBuffer buffer(1024);
    XmlFlattener flattener(&buffer, options);
    if (!flattener.Consume(context_.get(), doc)) {
      return ::testing::AssertionFailure() << "failed to flatten XML Tree";
    }

    std::unique_ptr<uint8_t[]> data = util::Copy(buffer);
    if (out_tree->setTo(data.get(), buffer.size(), true) != NO_ERROR) {
      return ::testing::AssertionFailure() << "flattened XML is corrupt";
    }
    return ::testing::AssertionSuccess();
  }

 protected:
  std::unique_ptr<IAaptContext> context_;
};

TEST_F(XmlFlattenerTest, FlattenXmlWithNoCompiledAttributes) {
  std::unique_ptr<xml::XmlResource> doc = test::BuildXmlDom(R"EOF(
            <View xmlns:test="http://com.test"
                  attr="hey">
              <Layout test:hello="hi" />
              <Layout>Some text</Layout>
            </View>)EOF");

  android::ResXMLTree tree;
  ASSERT_TRUE(Flatten(doc.get(), &tree));

  ASSERT_EQ(tree.next(), android::ResXMLTree::START_NAMESPACE);

  size_t len;
  const char16_t* namespace_prefix = tree.getNamespacePrefix(&len);
  EXPECT_EQ(StringPiece16(namespace_prefix, len), u"test");

  const char16_t* namespace_uri = tree.getNamespaceUri(&len);
  ASSERT_EQ(StringPiece16(namespace_uri, len), u"http://com.test");

  ASSERT_EQ(tree.next(), android::ResXMLTree::START_TAG);

  ASSERT_EQ(tree.getElementNamespace(&len), nullptr);
  const char16_t* tag_name = tree.getElementName(&len);
  EXPECT_EQ(StringPiece16(tag_name, len), u"View");

  ASSERT_EQ(1u, tree.getAttributeCount());
  ASSERT_EQ(tree.getAttributeNamespace(0, &len), nullptr);
  const char16_t* attr_name = tree.getAttributeName(0, &len);
  EXPECT_EQ(StringPiece16(attr_name, len), u"attr");

  EXPECT_EQ(0, tree.indexOfAttribute(nullptr, 0, u"attr",
                                     StringPiece16(u"attr").size()));

  ASSERT_EQ(tree.next(), android::ResXMLTree::START_TAG);

  ASSERT_EQ(tree.getElementNamespace(&len), nullptr);
  tag_name = tree.getElementName(&len);
  EXPECT_EQ(StringPiece16(tag_name, len), u"Layout");

  ASSERT_EQ(1u, tree.getAttributeCount());
  const char16_t* attr_namespace = tree.getAttributeNamespace(0, &len);
  EXPECT_EQ(StringPiece16(attr_namespace, len), u"http://com.test");

  attr_name = tree.getAttributeName(0, &len);
  EXPECT_EQ(StringPiece16(attr_name, len), u"hello");

  ASSERT_EQ(tree.next(), android::ResXMLTree::END_TAG);
  ASSERT_EQ(tree.next(), android::ResXMLTree::START_TAG);

  ASSERT_EQ(tree.getElementNamespace(&len), nullptr);
  tag_name = tree.getElementName(&len);
  EXPECT_EQ(StringPiece16(tag_name, len), u"Layout");
  ASSERT_EQ(0u, tree.getAttributeCount());

  ASSERT_EQ(tree.next(), android::ResXMLTree::TEXT);
  const char16_t* text = tree.getText(&len);
  EXPECT_EQ(StringPiece16(text, len), u"Some text");

  ASSERT_EQ(tree.next(), android::ResXMLTree::END_TAG);
  ASSERT_EQ(tree.getElementNamespace(&len), nullptr);
  tag_name = tree.getElementName(&len);
  EXPECT_EQ(StringPiece16(tag_name, len), u"Layout");

  ASSERT_EQ(tree.next(), android::ResXMLTree::END_TAG);
  ASSERT_EQ(tree.getElementNamespace(&len), nullptr);
  tag_name = tree.getElementName(&len);
  EXPECT_EQ(StringPiece16(tag_name, len), u"View");

  ASSERT_EQ(tree.next(), android::ResXMLTree::END_NAMESPACE);
  namespace_prefix = tree.getNamespacePrefix(&len);
  EXPECT_EQ(StringPiece16(namespace_prefix, len), u"test");

  namespace_uri = tree.getNamespaceUri(&len);
  ASSERT_EQ(StringPiece16(namespace_uri, len), u"http://com.test");

  ASSERT_EQ(tree.next(), android::ResXMLTree::END_DOCUMENT);
}

TEST_F(XmlFlattenerTest, FlattenCompiledXmlAndStripSdk21) {
  std::unique_ptr<xml::XmlResource> doc = test::BuildXmlDom(R"EOF(
            <View xmlns:android="http://schemas.android.com/apk/res/android"
                android:paddingStart="1dp"
                android:colorAccent="#ffffff"/>)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));
  ASSERT_TRUE(linker.sdk_levels().count(17) == 1);
  ASSERT_TRUE(linker.sdk_levels().count(21) == 1);

  android::ResXMLTree tree;
  XmlFlattenerOptions options;
  options.max_sdk_level = 17;
  ASSERT_TRUE(Flatten(doc.get(), &tree, options));

  while (tree.next() != android::ResXMLTree::START_TAG) {
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::BAD_DOCUMENT);
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::END_DOCUMENT);
  }

  ASSERT_EQ(1u, tree.getAttributeCount());
  EXPECT_EQ(uint32_t(0x010103b3), tree.getAttributeNameResID(0));
}

TEST_F(XmlFlattenerTest, FlattenCompiledXmlAndStripOnlyTools) {
  std::unique_ptr<xml::XmlResource> doc = test::BuildXmlDom(R"EOF(
            <View xmlns:tools="http://schemas.android.com/tools"
                xmlns:foo="http://schemas.android.com/foo"
                foo:bar="Foo"
                tools:ignore="MissingTranslation"/>)EOF");

  android::ResXMLTree tree;
  ASSERT_TRUE(Flatten(doc.get(), &tree));

  ASSERT_EQ(tree.next(), android::ResXMLTree::START_NAMESPACE);

  size_t len;
  const char16_t* namespace_prefix = tree.getNamespacePrefix(&len);
  EXPECT_EQ(StringPiece16(namespace_prefix, len), u"foo");

  const char16_t* namespace_uri = tree.getNamespaceUri(&len);
  ASSERT_EQ(StringPiece16(namespace_uri, len),
            u"http://schemas.android.com/foo");

  ASSERT_EQ(tree.next(), android::ResXMLTree::START_TAG);

  EXPECT_EQ(tree.indexOfAttribute("http://schemas.android.com/tools", "ignore"),
            android::NAME_NOT_FOUND);
  EXPECT_GE(tree.indexOfAttribute("http://schemas.android.com/foo", "bar"), 0);
}

TEST_F(XmlFlattenerTest, AssignSpecialAttributeIndices) {
  std::unique_ptr<xml::XmlResource> doc = test::BuildXmlDom(R"EOF(
            <View xmlns:android="http://schemas.android.com/apk/res/android"
                  android:id="@id/id"
                  class="str"
                  style="@id/id"/>)EOF");

  android::ResXMLTree tree;
  ASSERT_TRUE(Flatten(doc.get(), &tree));

  while (tree.next() != android::ResXMLTree::START_TAG) {
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::BAD_DOCUMENT);
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::END_DOCUMENT);
  }

  EXPECT_EQ(tree.indexOfClass(), 0);
  EXPECT_EQ(tree.indexOfStyle(), 1);
}

/*
 * The device ResXMLParser in libandroidfw differentiates between empty
 * namespace and null
 * namespace.
 */
TEST_F(XmlFlattenerTest, NoNamespaceIsNotTheSameAsEmptyNamespace) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDom("<View package=\"android\"/>");

  android::ResXMLTree tree;
  ASSERT_TRUE(Flatten(doc.get(), &tree));

  while (tree.next() != android::ResXMLTree::START_TAG) {
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::BAD_DOCUMENT);
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::END_DOCUMENT);
  }

  const StringPiece16 kPackage = u"package";
  EXPECT_GE(tree.indexOfAttribute(nullptr, 0, kPackage.data(), kPackage.size()),
            0);
}

TEST_F(XmlFlattenerTest, EmptyStringValueInAttributeIsNotNull) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDom("<View package=\"\"/>");

  android::ResXMLTree tree;
  ASSERT_TRUE(Flatten(doc.get(), &tree));

  while (tree.next() != android::ResXMLTree::START_TAG) {
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::BAD_DOCUMENT);
    ASSERT_NE(tree.getEventType(), android::ResXMLTree::END_DOCUMENT);
  }

  const StringPiece16 kPackage = u"package";
  ssize_t idx =
      tree.indexOfAttribute(nullptr, 0, kPackage.data(), kPackage.size());
  ASSERT_GE(idx, 0);

  size_t len;
  EXPECT_NE(nullptr, tree.getAttributeStringValue(idx, &len));
}

}  // namespace aapt