eecs280staff · amirkamil · Aug 10, 2023 · Aug 10, 2023
diff --git a/README.md b/README.md
@@ -3,15 +3,15 @@ Unit Test Framework
 
 [![`main` Build Status](https://travis-ci.com/eecs280staff/unit_test_framework.svg?branch=main)](https://travis-ci.com/eecs280staff/unit_test_framework)
 
-A lightweight, easy to use, C++11 unit testing framework implemented in a single `.h` file.
+A lightweight, easy to use, C++11 unit testing framework implemented in a single `.hpp` file.
 
 Publicly available tutorial: [https://eecs280staff.github.io/unit_test_framework/](https://eecs280staff.github.io/unit_test_framework/)
 
 
 ## Quickstart
-Install the unit test framework by copying `unit_test_framework.h` into your project.
+Install the unit test framework by copying `unit_test_framework.hpp` into your project.
 ```console
-$ wget https://raw.githubusercontent.com/eecs280staff/unit_test_framework/main/unit_test_framework.h
+$ wget https://raw.githubusercontent.com/eecs280staff/unit_test_framework/main/unit_test_framework.hpp
 ```
 
 Get the unit test example.
@@ -40,7 +40,7 @@ The example `my_tests.cpp` looks like this:
 ```c++
 // File: my_tests.cpp
 
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 // TEST takes in one argument: the name of the test case.
 // Note that the name of the test case must be a valid function name in C++.
@@ -64,7 +64,7 @@ TEST_MAIN()
 
 
 ## How to write a test case: The `TEST()` macro
-Test cases can be declared using the special `TEST()` macro defined in `unit_test_framework.h`:
+Test cases can be declared using the special `TEST()` macro defined in `unit_test_framework.hpp`:
 ```c++
 TEST(<test_name>) {
     // test case code

diff --git a/docs/README.md b/docs/README.md
@@ -17,16 +17,16 @@ In this tutorial, you will learn how to write test cases using a lightweight fra
 
 # Setting Up
 
-First, you will need the file `unit_test_framework.h`. This file is included with the starter code for EECS 280 projects where you are expected to use it. You can also download it directly (e.g. for this tutorial) with the following command.
+First, you will need the file `unit_test_framework.hpp`. This file is included with the starter code for EECS 280 projects where you are expected to use it. You can also download it directly (e.g. for this tutorial) with the following command.
 
 ```console
-$ wget https://raw.githubusercontent.com/eecs280staff/unit_test_framework/main/unit_test_framework.h
+$ wget https://raw.githubusercontent.com/eecs280staff/unit_test_framework/main/unit_test_framework.hpp
 ```
 
-For this tutorial, you'll need two files, `arrays.h` and `arrays.cpp`.
+For this tutorial, you'll need two files, `arrays.hpp` and `arrays.cpp`.
 
 ```console
-$ wget https://eecs280staff.github.io/unit_test_framework/arrays.h
+$ wget https://eecs280staff.github.io/unit_test_framework/arrays.hpp
 $ wget https://eecs280staff.github.io/unit_test_framework/arrays.cpp
 ```
 
@@ -35,8 +35,8 @@ These functions contain implementations of two functions (`slideRight()` and `fl
 Your tests should go in a new file, called `arrays_tests.cpp`. Add the following code to `arrays_tests.cpp`:
 
 ```c++
-#include "arrays.h"
-#include "unit_test_framework.h"
+#include "arrays.hpp"
+#include "unit_test_framework.hpp"
 
 // We define a test case with the TEST(<test_name>) macro.
 // <test_name> can be any valid C++ function name.
@@ -112,8 +112,8 @@ Assertion | Description
 
 # Example: Tests for an `add()` function
 
-Suppose we have an `add()` function that computes the sum of two
-`double` arguments:
+Suppose we have an `add()` function, defined in the file
+`eecs280math.hpp`, that computes the sum of two `double` arguments:
 
 ```c++
 double add(double first, double second) {
@@ -190,8 +190,8 @@ TEST(add_basic) {
 Finally, let's add `TEST_MAIN()` and any `#include`s that we need:
 
 ```c++
-#include "eecs280math.h"
-#include "unit_test_framework.h"
+#include "eecs280math.hpp"
+#include "unit_test_framework.hpp"
 
 TEST(add_basic) {
   double a = 0.1;
@@ -212,8 +212,8 @@ Now, let's add some real test cases for `slideRight()` and `flip()` to `arrays_t
 For example, here's one test for each function (you can replace your existing code in `arrays_tests.cpp` with the code below):
 
 ```c++
-#include "arrays.h"
-#include "unit_test_framework.h"
+#include "arrays.hpp"
+#include "unit_test_framework.hpp"
 
 // A helper function for comparing arrays. Returns true if the
 // arrays are the same size and contain the same values.

diff --git a/docs/arrays.cpp b/docs/arrays.cpp
@@ -1,4 +1,4 @@
-#include "arrays.h"
+#include "arrays.hpp"
 
 // REQUIRES: there are at least n elements in arr;
 //           n >= 1

diff --git a/docs/arrays.h → docs/arrays.hpp b/docs/arrays.h → docs/arrays.hpp
diff --git a/docs/my_tests.cpp b/docs/my_tests.cpp
@@ -1,6 +1,6 @@
 // File: my_tests.cpp
 
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 // TEST takes in one argument: the name of the test case.
 // Note that the name of the test case must be a valid function name in C++.

diff --git a/test/array_compare_error.cpp b/test/array_compare_error.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 TEST(foo) {
   int c[] = { 1, 2 };

diff --git a/test/char_array.cpp b/test/char_array.cpp
@@ -2,7 +2,7 @@
 #include <string>
 #include <vector>
 #include <utility>
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 using namespace std;
 

diff --git a/test/end_to_end_test.cpp b/test/end_to_end_test.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 #include <stdexcept>
 

diff --git a/test/missing_overload_error.cpp b/test/missing_overload_error.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 struct A {
   bool operator==(const A &rhs) const {

diff --git a/test/pairs_and_sequences.cpp b/test/pairs_and_sequences.cpp
@@ -2,7 +2,7 @@
 #include <string>
 #include <vector>
 #include <utility>
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 using namespace std;
 

diff --git a/test/sequence_equal.cpp b/test/sequence_equal.cpp
@@ -1,5 +1,5 @@
 #include <vector>
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 TEST(array_equal) {
   int a[] = { 1, 2 };

diff --git a/test/size_t_and_int.cpp b/test/size_t_and_int.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 TEST(size_t_and_int) {
   std::size_t s = 3u;

diff --git a/test/string_equal.cpp b/test/string_equal.cpp
@@ -1,5 +1,5 @@
 #include <string>
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 TEST(string_equal) {
   std::string s1 = "hello";

diff --git a/test/test_early_exit.cpp b/test/test_early_exit.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 TEST(early_exit) {
     std::exit(0);

diff --git a/test/test_name_conflict_file_with_tests.cpp b/test/test_name_conflict_file_with_tests.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 // We have a function with the same name in
 // test_name_conflict_file_with_non_static_func.cpp.

diff --git a/test/test_special_asserts.cpp b/test/test_special_asserts.cpp
@@ -1,4 +1,4 @@
-#include "unit_test_framework.h"
+#include "unit_test_framework.hpp"
 
 #include <iostream>
 #include <cassert>

diff --git a/unit_test_framework.h → unit_test_framework.hpp b/unit_test_framework.h → unit_test_framework.hpp
@@ -1,5 +1,5 @@
-#ifndef UNIT_TEST_FRAMEWORK_H
-#define UNIT_TEST_FRAMEWORK_H
+#ifndef UNIT_TEST_FRAMEWORK_HPP
+#define UNIT_TEST_FRAMEWORK_HPP
 
 #include <map>
 #include <utility>
@@ -648,4 +648,4 @@ void assert_almost_equal(double first, double second, double precision,
     throw TestFailure(reason.str(), line_number, assertion_text);
 }
 
-#endif  // UNIT_TEST_FRAMEWORK_H
+#endif  // UNIT_TEST_FRAMEWORK_HPP