gvisor/test/syscalls/linux/file_base.h

// Copyright 2018 Google LLC
//
// 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.

#ifndef GVISOR_TEST_SYSCALLS_FILE_BASE_H_
#define GVISOR_TEST_SYSCALLS_FILE_BASE_H_

#include <arpa/inet.h>
#include <errno.h>
#include <fcntl.h>
#include <netinet/in.h>
#include <stddef.h>
#include <stdio.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/uio.h>
#include <unistd.h>
#include <cstring>
#include <string>

#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "gtest/gtest.h"
#include "absl/strings/string_view.h"
#include "test/util/file_descriptor.h"
#include "test/util/posix_error.h"
#include "test/util/temp_path.h"
#include "test/util/test_util.h"

namespace gvisor {
namespace testing {

class FileTest : public ::testing::Test {
 public:
  void SetUp() override {
    test_pipe_[0] = -1;
    test_pipe_[1] = -1;

    test_file_name_ = NewTempAbsPath();
    test_file_fd_ = ASSERT_NO_ERRNO_AND_VALUE(
        Open(test_file_name_, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR));

    // FIXME: enable when mknod syscall is supported.
    // test_fifo_name_ = NewTempAbsPath();
    // ASSERT_THAT(mknod(test_fifo_name_.c_str()), S_IFIFO|0644, 0,
    //             SyscallSucceeds());
    // ASSERT_THAT(test_fifo_[1] = open(test_fifo_name_.c_str(),
    //                                             O_WRONLY),
    //             SyscallSucceeds());
    // ASSERT_THAT(test_fifo_[0] = open(test_fifo_name_.c_str(),
    //                                             O_RDONLY),
    //             SyscallSucceeds());

    ASSERT_THAT(pipe(test_pipe_), SyscallSucceeds());
    ASSERT_THAT(fcntl(test_pipe_[0], F_SETFL, O_NONBLOCK), SyscallSucceeds());
  }

  // CloseFile will allow the test to manually close the file descriptor.
  void CloseFile() { test_file_fd_.reset(); }

  // UnlinkFile will allow the test to manually unlink the file.
  void UnlinkFile() {
    if (!test_file_name_.empty()) {
      EXPECT_THAT(unlink(test_file_name_.c_str()), SyscallSucceeds());
      test_file_name_.clear();
    }
  }

  // ClosePipes will allow the test to manually close the pipes.
  void ClosePipes() {
    if (test_pipe_[0] > 0) {
      EXPECT_THAT(close(test_pipe_[0]), SyscallSucceeds());
    }

    if (test_pipe_[1] > 0) {
      EXPECT_THAT(close(test_pipe_[1]), SyscallSucceeds());
    }

    test_pipe_[0] = -1;
    test_pipe_[1] = -1;
  }

  void TearDown() override {
    CloseFile();
    UnlinkFile();
    ClosePipes();

    // FIXME: enable when mknod syscall is supported.
    // close(test_fifo_[0]);
    // close(test_fifo_[1]);
    // unlink(test_fifo_name_.c_str());
  }

  std::string test_file_name_;
  std::string test_fifo_name_;
  FileDescriptor test_file_fd_;

  int test_fifo_[2];
  int test_pipe_[2];
};

class SocketTest : public ::testing::Test {
 public:
  void SetUp() override {
    test_unix_stream_socket_[0] = -1;
    test_unix_stream_socket_[1] = -1;
    test_unix_dgram_socket_[0] = -1;
    test_unix_dgram_socket_[1] = -1;
    test_unix_seqpacket_socket_[0] = -1;
    test_unix_seqpacket_socket_[1] = -1;
    test_tcp_socket_[0] = -1;
    test_tcp_socket_[1] = -1;

    ASSERT_THAT(socketpair(AF_UNIX, SOCK_STREAM, 0, test_unix_stream_socket_),
                SyscallSucceeds());
    ASSERT_THAT(fcntl(test_unix_stream_socket_[0], F_SETFL, O_NONBLOCK),
                SyscallSucceeds());
    ASSERT_THAT(socketpair(AF_UNIX, SOCK_DGRAM, 0, test_unix_dgram_socket_),
                SyscallSucceeds());
    ASSERT_THAT(fcntl(test_unix_dgram_socket_[0], F_SETFL, O_NONBLOCK),
                SyscallSucceeds());
    ASSERT_THAT(
        socketpair(AF_UNIX, SOCK_SEQPACKET, 0, test_unix_seqpacket_socket_),
        SyscallSucceeds());
    ASSERT_THAT(fcntl(test_unix_seqpacket_socket_[0], F_SETFL, O_NONBLOCK),
                SyscallSucceeds());
  }

  void TearDown() override {
    close(test_unix_stream_socket_[0]);
    close(test_unix_stream_socket_[1]);

    close(test_unix_dgram_socket_[0]);
    close(test_unix_dgram_socket_[1]);

    close(test_unix_seqpacket_socket_[0]);
    close(test_unix_seqpacket_socket_[1]);

    close(test_tcp_socket_[0]);
    close(test_tcp_socket_[1]);
  }

  int test_unix_stream_socket_[2];
  int test_unix_dgram_socket_[2];
  int test_unix_seqpacket_socket_[2];
  int test_tcp_socket_[2];
};

// MatchesStringLength checks that a tuple argument of (struct iovec *, int)
// corresponding to an iovec array and its length, contains data that matches
// the std::string length strlen.
MATCHER_P(MatchesStringLength, strlen, "") {
  struct iovec* iovs = arg.first;
  int niov = arg.second;
  int offset = 0;
  for (int i = 0; i < niov; i++) {
    offset += iovs[i].iov_len;
  }
  if (offset != static_cast<int>(strlen)) {
    *result_listener << offset;
    return false;
  }
  return true;
}

// MatchesStringValue checks that a tuple argument of (struct iovec *, int)
// corresponding to an iovec array and its length, contains data that matches
// the std::string value str.
MATCHER_P(MatchesStringValue, str, "") {
  struct iovec* iovs = arg.first;
  int len = strlen(str);
  int niov = arg.second;
  int offset = 0;
  for (int i = 0; i < niov; i++) {
    struct iovec iov = iovs[i];
    if (len < offset) {
      *result_listener << "strlen " << len << " < offset " << offset;
      return false;
    }
    if (strncmp(static_cast<char*>(iov.iov_base), &str[offset], iov.iov_len)) {
      absl::string_view iovec_string(static_cast<char*>(iov.iov_base),
                                     iov.iov_len);
      *result_listener << iovec_string << " @offset " << offset;
      return false;
    }
    offset += iov.iov_len;
  }
  return true;
}

}  // namespace testing
}  // namespace gvisor

#endif  // GVISOR_TEST_SYSCALLS_FILE_BASE_H_