src/trace_redaction/scrub_process_trees_integrationtest.cc

/*
 * Copyright (C) 2024 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 <string>
#include <string_view>
#include <vector>

#include "perfetto/base/status.h"
#include "perfetto/ext/base/file_utils.h"
#include "protos/perfetto/trace/ps/process_tree.pbzero.h"
#include "protos/perfetto/trace/trace.pbzero.h"
#include "src/base/test/status_matchers.h"
#include "src/base/test/tmp_dir_tree.h"
#include "src/base/test/utils.h"
#include "src/trace_redaction/build_timeline.h"
#include "src/trace_redaction/find_package_uid.h"
#include "src/trace_redaction/optimize_timeline.h"
#include "src/trace_redaction/scrub_process_trees.h"
#include "src/trace_redaction/trace_redaction_framework.h"
#include "src/trace_redaction/trace_redactor.h"
#include "test/gtest_and_gmock.h"

namespace perfetto::trace_redaction {

namespace {

constexpr std::string_view kTracePath =
    "test/data/trace-redaction-general.pftrace";
constexpr std::string_view kProcessName =
    "com.Unity.com.unity.multiplayer.samples.coop";

}  // namespace

class ScrubProcessTreesIntegrationTest : public testing::Test {
 protected:
  void SetUp() override {
    // ScrubProcessTrees depends on:
    //    - FindPackageUid    (creates: uid)
    //    - OptimizeTimeline  (creates: optimized timeline)
    //
    // OptimizeTimeline depends on:
    //    - FindPackageUid (uses: uid)
    //    - BuildTimeline  (uses: timeline)
    //
    // BuildTimeline depends on.... nothing
    // FindPackageUid depends on... nothing

    redactor_.collectors()->emplace_back(new FindPackageUid());
    redactor_.collectors()->emplace_back(new BuildTimeline());
    redactor_.builders()->emplace_back(new OptimizeTimeline());
    redactor_.transformers()->emplace_back(new ScrubProcessTrees());

    // In this case, the process and package have the same name.
    context_.package_name = kProcessName;

    src_trace_ = base::GetTestDataPath(std::string(kTracePath));

    dest_trace_ = tmp_dir_.AbsolutePath("dst.pftrace");
    tmp_dir_.TrackFile("dst.pftrace");
  }

  base::Status Redact() {
    return redactor_.Redact(src_trace_, dest_trace_, &context_);
  }

  base::StatusOr<std::string> LoadOriginal() const {
    return ReadRawTrace(src_trace_);
  }

  base::StatusOr<std::string> LoadRedacted() const {
    return ReadRawTrace(dest_trace_);
  }

  std::vector<std::string> CollectProcessNames(
      protos::pbzero::Trace::Decoder trace) const {
    std::vector<std::string> names;

    for (auto packet_it = trace.packet(); packet_it; ++packet_it) {
      protos::pbzero::TracePacket::Decoder packet(*packet_it);

      if (!packet.has_process_tree()) {
        continue;
      }

      protos::pbzero::ProcessTree::Decoder process_tree(packet.process_tree());

      for (auto process_it = process_tree.processes(); process_it;
           ++process_it) {
        protos::pbzero::ProcessTree::Process::Decoder process(*process_it);

        if (process.has_cmdline()) {
          names.push_back(process.cmdline()->as_std_string());
        }
      }
    }

    return names;
  }

 private:
  base::StatusOr<std::string> ReadRawTrace(const std::string& path) const {
    std::string redacted_buffer;

    if (base::ReadFile(path, &redacted_buffer)) {
      return redacted_buffer;
    }

    return base::ErrStatus("Failed to read %s", path.c_str());
  }

  Context context_;
  TraceRedactor redactor_;

  base::TmpDirTree tmp_dir_;

  std::string src_trace_;
  std::string dest_trace_;
};

TEST_F(ScrubProcessTreesIntegrationTest, RemovesProcessNamesFromProcessTrees) {
  ASSERT_OK(Redact());

  auto original_trace_str = LoadOriginal();
  ASSERT_OK(original_trace_str);

  auto redacted_trace_str = LoadRedacted();
  ASSERT_OK(redacted_trace_str);

  protos::pbzero::Trace::Decoder original_trace(original_trace_str.value());
  auto original_processes = CollectProcessNames(std::move(original_trace));

  ASSERT_GT(original_processes.size(), 1u);

  protos::pbzero::Trace::Decoder redacted_trace(redacted_trace_str.value());
  auto redacted_processes = CollectProcessNames(std::move(redacted_trace));

  ASSERT_EQ(redacted_processes.size(), 1u);
  ASSERT_EQ(redacted_processes.at(0), kProcessName);
}

}  // namespace perfetto::trace_redaction