crc32_test.cc

Go to the documentation of this file.

#include "catch2/catch.hpp"

#include "cetlib/crc32.h"

#include <string>

#include "CRC32Calculator.h"

using namespace std::string_literals;

using cet::crc32;

namespace {
  auto const TESTA = "abc"s;
  auto const TESTB =
    "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"s;
  auto const TESTC = "\
1 First God made heaven & earth \
2 The earth was without form and void, and darkness was upon the face of the deep; and the Spirit of God was moving over the face of the waters. \
3 And God said, \"Let there be light\"; and there was light. \
4 And God saw that the light was good; and God separated the light from the darkness. \
5 God called the light Day, and the darkness he called Night. And there was evening and there was morning, one day. \
6 And God said, \"Let there be a firmament in the midst of the waters, and let it separate the waters from the waters.\" \
7 And God made the firmament and separated the waters which were under the firmament from the waters which were above the firmament. And it was so. \
8 And God called the firmament Heaven. And there was evening and there was morning, a second day. \
9 And God said, \"Let the waters under the heavens be gathered together into one place, and let the dry land appear.\" And it was so. \
10 God called the dry land Earth, and the waters that were gathered together he called Seas. And God saw that it was good. \
11 And God said, \"Let the earth put forth vegetation, plants yielding seed, and fruit trees bearing fruit in which is their seed, each according to its kind, upon the earth.\" And it was so. \
12 The earth brought forth vegetation, plants yielding seed according to their own kinds, and trees bearing fruit in which is their seed, each according to its kind. And God saw that it was good. \
13 And there was evening and there was morning, a third day. \
14 And God said, \"Let there be lights in the firmament of the heavens to separate the day from the night; and let them be for signs and for seasons and for days and years, \
15 and let them be lights in the firmament of the heavens to give light upon the earth.\" And it was so. \
16 And God made the two great lights, the greater light to rule the day, and the lesser light to rule the night; he made the stars also. \
17 And God set them in the firmament of the heavens to give light upon the earth, \
18 to rule over the day and over the night, and to separate the light from the darkness. And God saw that it was good. \
19 And there was evening and there was morning, a fourth day. \
20 And God said, \"Let the waters bring forth swarms of living creatures, and let birds fly above the earth across the firmament of the heavens.\" \
21 So God created the great sea monsters and every living creature that moves, with which the waters swarm, according to their kinds, and every winged bird according to its kind. And God saw that it was good. \
22 And God blessed them, saying, \"Be fruitful and multiply and fill the waters in the seas, and let birds multiply on the earth.\" \
23 And there was evening and there was morning, a fifth day. \
24 And God said, \"Let the earth bring forth living creatures according to their kinds: cattle and creeping things and beasts of the earth according to their kinds.\" And it was so. \
25 And God made the beasts of the earth according to their kinds and the cattle according to their kinds, and everything that creeps upon the ground according to its kind. And God saw that it was good. \
26 Then God said, \"Let us make man in our image, after our likeness; and let them have dominion over the fish of the sea, and over the birds of the air, and over the cattle, and over all the earth, and over every creeping thing that creeps upon the earth.\" \
27 So God created man in his own image, in the image of God he created him; male and female he created them. \
28 And God blessed them, and God said to them, \"Be fruitful and multiply, and fill the earth and subdue it; and have dominion over the fish of the sea and over the birds of the air and over every living thing that moves upon the earth.\" \
29 And God said, \"Behold, I have given you every plant yielding seed which is upon the face of all the earth, and every tree with seed in its fruit; you shall have them for food. \
30 And to every beast of the earth, and to every bird of the air, and to everything that creeps on the earth, everything that has the breath of life, I have given every green plant for food.\" And it was so. \
31 And God saw everything that he had made, and behold, it was very good. And there was evening and there was morning, a sixth day.\
"s;
}

SCENARIO("We can produce CRC32 checksums accurately")
{
  crc32 crc;

  GIVEN("We have a short string")
  {
    WHEN("We create CRC32 digests in two different ways")
    {
      crc << TESTA;
      cet::CRC32Calculator const refMaker(TESTA);

      auto const digest = crc.digest();
      auto const ref = refMaker.checksum();

      THEN("The checksums compare equal") { CHECK(digest == ref); }
    }
  }

  GIVEN("We have a longer string")
  {
    WHEN("We create CRC32 digests in two different ways")
    {
      crc << TESTB;
      cet::CRC32Calculator const refMaker(TESTB);

      auto const digest = crc.digest();
      auto const ref = refMaker.checksum();

      THEN("The checksums compare equal") { CHECK(digest == ref); }
    }
  }

  GIVEN("We have a *much* longer string")
  {
    WHEN("We create CRC32 digests in two different ways")
    {
      crc << TESTC;
      cet::CRC32Calculator const refMaker(TESTC);

      auto const digest = crc.digest();
      auto const ref = refMaker.checksum();

      THEN("The checksums compare equal") { CHECK(digest == ref); }
    }
  }

  GIVEN("We have a string with a known, externally calculated CRC32 checksum")
  {
    WHEN("We create CRC32 digests in two different ways")
    {
      auto const testString = "type_label_instance"s;
      auto const process_suffix = "_process"s;
      auto const knownResult = 1215348599u;

      crc << (testString + process_suffix);
      cet::CRC32Calculator const refMaker(testString + process_suffix);

      auto const digest = crc.digest();
      auto const ref = refMaker.checksum();

      THEN("All three checksums compare equal")
      {
        CHECK(digest == knownResult);
        CHECK(digest == ref);
      }
      WHEN("We insert more text before calculating a digest")
      {
        crc32 crc_insert(testString);
        crc_insert << process_suffix;

        THEN("We get the same answer")
        {
          CHECK(crc_insert.digest() == knownResult);
        }
      }
    }
  }

  GIVEN("We have an empty string")
  {
    WHEN("We calculate its CRC32 checksum")
    {
      crc << "";

      THEN("It should be 0") { CHECK(crc.digest() == 0); }
    }
  }
}