mindspore/tests/ut/cpp/dataset/queue_test.cc

/**
 * Copyright 2019-2022 Huawei Technologies Co., Ltd
 *
 * 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 "common/common.h"
#include "gtest/gtest.h"
#include "minddata/dataset/util/task_manager.h"
#include "minddata/dataset/util/queue.h"
#include <atomic>
#include <chrono>
#include <random>
#include "utils/log_adapter.h"

using namespace mindspore::dataset;

class MindDataTestQueue : public UT::Common {
 public:
  MindDataTestQueue() {}

  void SetUp() {}
};

int gRefCountDestructorCalled;

class RefCount {
 public:
  RefCount() : v_(nullptr) {}
  explicit RefCount(int x) : v_(std::make_shared<int>(x)) {}
  RefCount(const RefCount &o) : v_(o.v_) {}
  ~RefCount() {
    MS_LOG(DEBUG) << "Destructor of RefCount called" << std::endl;
    gRefCountDestructorCalled++;
  }
  RefCount &operator=(const RefCount &o) {
    v_ = o.v_;
    return *this;
  }
  RefCount(RefCount &&o) : v_(std::move(o.v_)) {}
  RefCount &operator=(RefCount &&o) {
    if (&o != this) {
      v_ = std::move(o.v_);
    }
    return *this;
  }

  std::shared_ptr<int> v_;
};

/// Feature: Queue
/// Description: Test Queue by passing shared pointer and destructor of Queue
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test1) {
  // Passing shared pointer along the queue
  Queue<std::shared_ptr<int>> que(3);
  std::shared_ptr<int> a = std::make_shared<int>(20);
  Status rc = que.Add(a);
  ASSERT_TRUE(rc.IsOk());
  // Use count should be 2 right now. a plus the one in the queue.
  ASSERT_EQ(a.use_count(), 2);
  std::shared_ptr<int> b;
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(*b, 20);
  // Use count should remain 2. a and b. No copy in the queue.
  ASSERT_EQ(a.use_count(), 2);
  a.reset(new int(5));
  ASSERT_EQ(a.use_count(), 1);
  // Push again but expect a is nullptr after push
  rc = que.Add(std::move(a));
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(a.use_count(), 0);
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(*b, 5);
  ASSERT_EQ(b.use_count(), 1);
  // Test construct in place
  rc = que.EmplaceBack(std::make_shared<int>(100));
  ASSERT_TRUE(rc.IsOk());
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(*b, 100);
  ASSERT_EQ(b.use_count(), 1);
  // Test the destructor of the Queue by add an element in the queue without popping it and let the queue go
  // out of scope.
  rc = que.EmplaceBack(std::make_shared<int>(2000));
  ASSERT_TRUE(rc.IsOk());
}

/// Feature: Queue
/// Description: Test Queue by passing Status object and destructor of Queue
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test2) {
  // Passing status object
  Queue<Status> que(3);
  Status rc_send(StatusCode::kMDUnexpectedError, __LINE__, __FILE__, "Oops");
  Status rc = que.Add(rc_send);
  ASSERT_TRUE(rc.IsOk());
  Status rc_recv;
  rc = que.PopFront(&rc_recv);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(rc_recv, rc_send);
  rc = que.EmplaceBack(StatusCode::kMDOutOfMemory, "Test emplace");
  ASSERT_TRUE(rc.IsOk());
  Status rc_recv2;
  rc = que.PopFront(&rc_recv2);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_TRUE(rc_recv2 == StatusCode::kMDOutOfMemory);
}

/// Feature: Queue
/// Description: Test Queue by passing unique pointer and destructor of Queue
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test3) {
  Queue<std::unique_ptr<int>> que(3);
  auto a = std::make_unique<int>(3);
  Status rc = que.Add(std::move(a));
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(a.get(), nullptr);
  std::unique_ptr<int> b;
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(*b, 3);
  rc = que.EmplaceBack(new int(40));
  ASSERT_TRUE(rc.IsOk());
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(*b, 40);
}

void test4() {
  gRefCountDestructorCalled = 0;
  // Pass a structure along the queue.
  Queue<RefCount> que(3);
  int num {3};
  RefCount a(num);
  Status rc = que.Add(a);
  ASSERT_TRUE(rc.IsOk());
  RefCount b;
  rc = que.PopFront(&b);
  ASSERT_TRUE(rc.IsOk());
  ASSERT_EQ(b.v_.use_count(), 2);
  ASSERT_EQ(*(b.v_.get()), 3);
  // Test the destructor of the Queue by adding an element without popping.
  rc = que.EmplaceBack(10);
  ASSERT_TRUE(rc.IsOk());
}

/// Feature: Queue
/// Description: Test Queue by passing a structure and destructor of Queue
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test4) { test4(); }

/// Feature: Queue
/// Description: Test destructor of RefCount after running Test4
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test5) {
  test4();
  // Assume we have run Test4. The destructor of the RefCount should be called 4 times.
  // One for a. One for b. One for the stale element in the queue. 3 more for
  // the one in the queue (but they are empty).
  ASSERT_EQ(gRefCountDestructorCalled, 6);
}

/// Feature: Queue
/// Description: Test list of Queues by inserting a number into a specific queue and pop it
/// Expectation: Output is equal to the expected output
TEST_F(MindDataTestQueue, Test6) {
  // Create a list of queues
  QueueList<std::unique_ptr<int>> my_list_of_queues;
  const int chosen_queue_index = 2;
  const int num_queues = 4;
  const int queue_capacity = 3;
  my_list_of_queues.Init(num_queues, queue_capacity);
  // Now try to insert a number into a specific queue and pop it
  auto a = std::make_unique<int>(99);
  Status rc = my_list_of_queues[chosen_queue_index]->Add(std::move(a));
  ASSERT_TRUE(rc.IsOk());
  std::unique_ptr<int> pepped_value;
  rc = my_list_of_queues[chosen_queue_index]->PopFront(&pepped_value);
  ASSERT_TRUE(rc.IsOk());
  MS_LOG(INFO) << "Popped value " << *pepped_value << " from queue index " << chosen_queue_index;
  ASSERT_EQ(*pepped_value, 99);
}

/// Feature: Test basic check in the resize.
/// Description: Check false input for resize function.
/// Expectation: Return false when the input is unexpected, and true when the new capacity is the same as original.
TEST_F(MindDataTestQueue, TestResize1) {
  // Create a list of queues with capacity = 3
  Queue<TensorRow> queue(3);
  ASSERT_EQ(3, queue.capacity());
  // Add 3 rows into the queue
  TensorRow a;
  std::shared_ptr<Tensor> test_tensor1;
  std::vector<float> input = {1.1, 0.2, 0.3, 0.4, 0.5, 0.6, 1.2, 0.7, 0.8, 0.9, 1.0, 2.0, 1.3, 3.0, 4.0};
  EXPECT_OK(Tensor::CreateFromVector(input, TensorShape{3, 5}, &test_tensor1));
  a.push_back(test_tensor1);
  EXPECT_OK(queue.Add(a));

  TensorRow b;
  std::shared_ptr<Tensor> test_tensor2;
  EXPECT_OK(Tensor::CreateScalar(true, &test_tensor2));
  b.push_back(test_tensor2);
  EXPECT_OK(queue.Add(b));

  TensorRow c;
  std::shared_ptr<Tensor> test_tensor3;
  EXPECT_OK(Tensor::CreateFromVector(input, &test_tensor3));
  c.push_back(test_tensor3);
  EXPECT_OK(queue.Add(c));
  ASSERT_EQ(3, queue.size());

  // Check false if input is equal to or smaller than 0
  EXPECT_ERROR(queue.Resize(0));
  EXPECT_ERROR(queue.Resize(-1));
  // Check true if the new capacity is the same as original
  EXPECT_OK(queue.Resize(3));
}

/// Feature: Check resize is finished without changing elements and influencing operations.
/// Description: Compare elements in queue before and after resize, and test add/pop/reset.
/// Expectation: Elements in queue after resize are the same as the original queue.
TEST_F(MindDataTestQueue, TestResize2) {
  // Create a list of queues with capacity = 3
  Queue<TensorRow> queue(3);
  ASSERT_EQ(3, queue.capacity());
  // Add 3 rows into the queue
  TensorRow a;
  std::shared_ptr<Tensor> test_tensor1;
  std::vector<float> input = {1.1, 0.2, 0.3, 0.4, 0.5, 0.6, 1.2, 0.7, 0.8, 0.9, 1.0, 2.0, 1.3, 3.0, 4.0};
  EXPECT_OK(Tensor::CreateFromVector(input, TensorShape{3, 5}, &test_tensor1));
  a.push_back(test_tensor1);
  EXPECT_OK(queue.Add(a));

  TensorRow b;
  std::shared_ptr<Tensor> test_tensor2;
  EXPECT_OK(Tensor::CreateScalar(true, &test_tensor2));
  b.push_back(test_tensor2);
  EXPECT_OK(queue.Add(b));

  TensorRow c;
  std::shared_ptr<Tensor> test_tensor3;
  EXPECT_OK(Tensor::CreateFromVector(input, &test_tensor3));
  c.push_back(test_tensor3);
  EXPECT_OK(queue.Add(c));
  ASSERT_EQ(3, queue.size());

  // Check true if the resize is smaller than current size
  EXPECT_OK(queue.Resize(1));
  ASSERT_EQ(1, queue.capacity());
  // Expect the rows after resize are the same as original input, there should be still 1 element in the queue
  TensorRow d;
  EXPECT_OK(queue.PopFront(&d));
  EXPECT_EQ(a.getRow(), d.getRow());
  ASSERT_EQ(1, queue.size());
  // Check true if the resize is larger than current size, and capacity is changed
  EXPECT_OK(queue.Resize(12));
  ASSERT_EQ(12, queue.capacity());
  // Check add operation after resize
  EXPECT_OK(queue.Add(a));
  ASSERT_EQ(3, queue.size());
  // Check pop operation after resize
  EXPECT_OK(queue.PopFront(&d));
  EXPECT_EQ(b.getRow(), d.getRow());
  EXPECT_OK(queue.PopFront(&d));
  EXPECT_EQ(c.getRow(), d.getRow());
  ASSERT_EQ(1, queue.size());
  queue.Reset();
  ASSERT_EQ(0, queue.size());
}