Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 20ac0340 authored by Shane Farmer's avatar Shane Farmer
Browse files

AAPT2: Specify the output APK in log messages 

Extend the context wrapper to allow it to also know the current artifact
that is being generated and to use that as a source for diagnostics
messages.

Test: ran unit tests
Test: manually ran optimize to split and APK and verified log messages

Change-Id: I1d66dacb38db58d57d2fffaa19f5fdaff9f908df
parent 41499dfe

tools/aapt2/optimize/MultiApkGenerator.cpp

+44 −32
Original line number Original line Diff line number Diff line
@@ -84,6 +84,9 @@ class ContextWrapper : public IAaptContext { 
  }

  }





  IDiagnostics* GetDiagnostics() override {

  IDiagnostics* GetDiagnostics() override {

    if (source_diag_) {

      return source_diag_.get();

    }

    return context_->GetDiagnostics();

    return context_->GetDiagnostics();

  }

  }
@@ -111,8 +114,13 @@ class ContextWrapper : public IAaptContext { 
    min_sdk_ = min_sdk;

    min_sdk_ = min_sdk;

  }

  }





  void SetSource(const Source& source) {

    source_diag_ = util::make_unique<SourcePathDiagnostics>(source, context_->GetDiagnostics());

  }



 private:

 private:

  IAaptContext* context_;

  IAaptContext* context_;

  std::unique_ptr<SourcePathDiagnostics> source_diag_;





  int min_sdk_ = -1;

  int min_sdk_ = -1;

};

};
@@ -123,7 +131,6 @@ MultiApkGenerator::MultiApkGenerator(LoadedApk* apk, IAaptContext* context) 




bool MultiApkGenerator::FromBaseApk(const MultiApkGeneratorOptions& options) {

bool MultiApkGenerator::FromBaseApk(const MultiApkGeneratorOptions& options) {

  // TODO(safarmer): Handle APK version codes for the generated APKs.

  // TODO(safarmer): Handle APK version codes for the generated APKs.

  IDiagnostics* diag = context_->GetDiagnostics();

  const PostProcessingConfiguration& config = options.config;

  const PostProcessingConfiguration& config = options.config;





  const std::string& apk_name = file::GetFilename(apk_->GetSource().path).to_string();

  const std::string& apk_name = file::GetFilename(apk_->GetSource().path).to_string();
@@ -132,55 +139,60 @@ bool MultiApkGenerator::FromBaseApk(const MultiApkGeneratorOptions& options) { 




  // For now, just write out the stripped APK since ABI splitting doesn't modify anything else.

  // For now, just write out the stripped APK since ABI splitting doesn't modify anything else.

  for (const Artifact& artifact : config.artifacts) {

  for (const Artifact& artifact : config.artifacts) {

    SourcePathDiagnostics diag{{apk_name}, context_->GetDiagnostics()};



    FilterChain filters;

    FilterChain filters;





    if (!artifact.name && !config.artifact_format) {

    if (!artifact.name && !config.artifact_format) {

      diag->Error(

      diag.Error(

          DiagMessage() << "Artifact does not have a name and no global name template defined");

          DiagMessage() << "Artifact does not have a name and no global name template defined");

      return false;

      return false;

    }

    }





    Maybe<std::string> artifact_name =

    Maybe<std::string> maybe_artifact_name =

        (artifact.name) ? artifact.Name(apk_name, diag)

        (artifact.name) ? artifact.Name(apk_name, &diag)

                        : artifact.ToArtifactName(config.artifact_format.value(), apk_name, diag);

                        : artifact.ToArtifactName(config.artifact_format.value(), apk_name, &diag);





    if (!artifact_name) {

    if (!maybe_artifact_name) {

      diag->Error(DiagMessage() << "Could not determine split APK artifact name");

      diag.Error(DiagMessage() << "Could not determine split APK artifact name");

      return false;

      return false;

    }

    }





    const std::string& artifact_name = maybe_artifact_name.value();



    ContextWrapper wrapped_context{context_};

    wrapped_context.SetSource({artifact_name});



    std::unique_ptr<ResourceTable> table =

    std::unique_ptr<ResourceTable> table =

        FilterTable(artifact, config, *apk_->GetResourceTable(), &filters);

        FilterTable(artifact, config, *apk_->GetResourceTable(), &wrapped_context, &filters);

    if (!table) {

    if (!table) {

      return false;

      return false;

    }

    }





    std::unique_ptr<XmlResource> manifest;

    std::unique_ptr<XmlResource> manifest;

    if (!UpdateManifest(artifact, config, &manifest, diag)) {

    if (!UpdateManifest(artifact, config, &manifest, &diag)) {

      diag->Error(DiagMessage() << "could not update AndroidManifest.xml for "

      diag.Error(DiagMessage() << "could not update AndroidManifest.xml for output artifact");

                                << artifact_name.value());

      return false;

      return false;

    }

    }





    std::string out = options.out_dir;

    std::string out = options.out_dir;

    if (!file::mkdirs(out)) {

    if (!file::mkdirs(out)) {

      context_->GetDiagnostics()->Warn(DiagMessage() << "could not create out dir: " << out);

      diag.Warn(DiagMessage() << "could not create out dir: " << out);

    }

    }

    file::AppendPath(&out, artifact_name.value());

    file::AppendPath(&out, artifact_name);





    if (context_->IsVerbose()) {

    if (context_->IsVerbose()) {

      context_->GetDiagnostics()->Note(DiagMessage() << "Generating split: " << out);

      diag.Note(DiagMessage() << "Generating split: " << out);

    }

    }





    std::unique_ptr<IArchiveWriter> writer =

    std::unique_ptr<IArchiveWriter> writer = CreateZipFileArchiveWriter(&diag, out);

        CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);





    if (context_->IsVerbose()) {

    if (context_->IsVerbose()) {

      diag->Note(DiagMessage() << "Writing output: " << out);

      diag.Note(DiagMessage() << "Writing output: " << out);

    }

    }





    if (!apk_->WriteToArchive(context_, table.get(), options.table_flattener_options, &filters,

    if (!apk_->WriteToArchive(&wrapped_context, table.get(), options.table_flattener_options,

                              writer.get(), manifest.get())) {

                              &filters, writer.get(), manifest.get())) {

      return false;

      return false;

    }

    }

  }

  }
@@ -191,10 +203,10 @@ bool MultiApkGenerator::FromBaseApk(const MultiApkGeneratorOptions& options) { 
std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable(

std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable(

    const configuration::Artifact& artifact,

    const configuration::Artifact& artifact,

    const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

    const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

    FilterChain* filters) {

    IAaptContext* context, FilterChain* filters) {

  TableSplitterOptions splits;

  TableSplitterOptions splits;

  AxisConfigFilter axis_filter;

  AxisConfigFilter axis_filter;

  ContextWrapper wrappedContext{context_};

  ContextWrapper wrapped_context{context};





  if (artifact.abi_group) {

  if (artifact.abi_group) {

    const std::string& group_name = artifact.abi_group.value();

    const std::string& group_name = artifact.abi_group.value();
@@ -202,7 +214,7 @@ std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable( 
    auto group = config.abi_groups.find(group_name);

    auto group = config.abi_groups.find(group_name);

    // TODO: Remove validation when configuration parser ensures referential integrity.

    // TODO: Remove validation when configuration parser ensures referential integrity.

    if (group == config.abi_groups.end()) {

    if (group == config.abi_groups.end()) {

      context_->GetDiagnostics()->Error(DiagMessage() << "could not find referenced ABI group '"

      context->GetDiagnostics()->Error(DiagMessage() << "could not find referenced ABI group '"

                                                     << group_name << "'");

                                                     << group_name << "'");

      return {};

      return {};

    }

    }
@@ -215,8 +227,8 @@ std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable( 
    auto group = config.screen_density_groups.find(group_name);

    auto group = config.screen_density_groups.find(group_name);

    // TODO: Remove validation when configuration parser ensures referential integrity.

    // TODO: Remove validation when configuration parser ensures referential integrity.

    if (group == config.screen_density_groups.end()) {

    if (group == config.screen_density_groups.end()) {

      context_->GetDiagnostics()->Error(DiagMessage() << "could not find referenced group '"

      context->GetDiagnostics()->Error(DiagMessage()

                                                      << group_name << "'");

                                       << "could not find referenced group '" << group_name << "'");

      return {};

      return {};

    }

    }
@@ -231,8 +243,8 @@ std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable( 
    auto group = config.locale_groups.find(group_name);

    auto group = config.locale_groups.find(group_name);

    // TODO: Remove validation when configuration parser ensures referential integrity.

    // TODO: Remove validation when configuration parser ensures referential integrity.

    if (group == config.locale_groups.end()) {

    if (group == config.locale_groups.end()) {

      context_->GetDiagnostics()->Error(DiagMessage() << "could not find referenced group '"

      context->GetDiagnostics()->Error(DiagMessage()

                                                      << group_name << "'");

                                       << "could not find referenced group '" << group_name << "'");

      return {};

      return {};

    }

    }
@@ -243,16 +255,16 @@ std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable( 
    splits.config_filter = &axis_filter;

    splits.config_filter = &axis_filter;

  }

  }





  Maybe<AndroidSdk> sdk = GetAndroidSdk(artifact, config, context_->GetDiagnostics());

  Maybe<AndroidSdk> sdk = GetAndroidSdk(artifact, config, context->GetDiagnostics());

  if (sdk && sdk.value().min_sdk_version) {

  if (sdk && sdk.value().min_sdk_version) {

    wrappedContext.SetMinSdkVersion(sdk.value().min_sdk_version.value());

    wrapped_context.SetMinSdkVersion(sdk.value().min_sdk_version.value());

  }

  }





  std::unique_ptr<ResourceTable> table = old_table.Clone();

  std::unique_ptr<ResourceTable> table = old_table.Clone();





  VersionCollapser collapser;

  VersionCollapser collapser;

  if (!collapser.Consume(&wrappedContext, table.get())) {

  if (!collapser.Consume(&wrapped_context, table.get())) {

    context_->GetDiagnostics()->Error(DiagMessage() << "Failed to strip versioned resources");

    context->GetDiagnostics()->Error(DiagMessage() << "Failed to strip versioned resources");

    return {};

    return {};

  }

  }

tools/aapt2/optimize/MultiApkGenerator.h

+1 −1
Original line number Original line Diff line number Diff line
@@ -47,7 +47,7 @@ class MultiApkGenerator { 
  virtual std::unique_ptr<ResourceTable> FilterTable(

  virtual std::unique_ptr<ResourceTable> FilterTable(

      const configuration::Artifact& artifact,

      const configuration::Artifact& artifact,

      const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

      const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

      FilterChain* chain);

      IAaptContext* context, FilterChain* chain);





 private:

 private:

  IDiagnostics* GetDiagnostics() {

  IDiagnostics* GetDiagnostics() {

tools/aapt2/optimize/MultiApkGenerator_test.cpp

+5 −5
Original line number Original line Diff line number Diff line
@@ -63,8 +63,8 @@ class MultiApkGeneratorWrapper : public MultiApkGenerator { 
  std::unique_ptr<ResourceTable> FilterTable(

  std::unique_ptr<ResourceTable> FilterTable(

      const configuration::Artifact& artifact,

      const configuration::Artifact& artifact,

      const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

      const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table,

      FilterChain* pChain) override {

      IAaptContext* context, FilterChain* filter_chain) override {

    return MultiApkGenerator::FilterTable(artifact, config, old_table, pChain);

    return MultiApkGenerator::FilterTable(artifact, config, old_table, context, filter_chain);

  }

  }

};

};
@@ -128,7 +128,7 @@ TEST_F(MultiApkGeneratorTest, VersionFilterNewerVersion) { 




  MultiApkGeneratorWrapper generator{&apk, ctx.get()};

  MultiApkGeneratorWrapper generator{&apk, ctx.get()};

  std::unique_ptr<ResourceTable> split =

  std::unique_ptr<ResourceTable> split =

      generator.FilterTable(x64, config, *apk.GetResourceTable(), &chain);

      generator.FilterTable(x64, config, *apk.GetResourceTable(), ctx.get(), &chain);





  ResourceTable* new_table = split.get();

  ResourceTable* new_table = split.get();

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());
@@ -169,7 +169,7 @@ TEST_F(MultiApkGeneratorTest, VersionFilterOlderVersion) { 




  MultiApkGeneratorWrapper generator{&apk, ctx.get()};;

  MultiApkGeneratorWrapper generator{&apk, ctx.get()};;

  std::unique_ptr<ResourceTable> split =

  std::unique_ptr<ResourceTable> split =

      generator.FilterTable(x64, config, *apk.GetResourceTable(), &chain);

      generator.FilterTable(x64, config, *apk.GetResourceTable(), ctx.get(), &chain);





  ResourceTable* new_table = split.get();

  ResourceTable* new_table = split.get();

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());
@@ -204,7 +204,7 @@ TEST_F(MultiApkGeneratorTest, VersionFilterNoVersion) { 




  MultiApkGeneratorWrapper generator{&apk, ctx.get()};

  MultiApkGeneratorWrapper generator{&apk, ctx.get()};

  std::unique_ptr<ResourceTable> split =

  std::unique_ptr<ResourceTable> split =

      generator.FilterTable(x64, config, *apk.GetResourceTable(), &chain);

      generator.FilterTable(x64, config, *apk.GetResourceTable(), ctx.get(), &chain);





  ResourceTable* new_table = split.get();

  ResourceTable* new_table = split.get();

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());

  EXPECT_THAT(ValueForConfig(new_table, mdpi_), IsNull());