Stub out tests for reports

Outline test cases for reports. Reports are still very much in flux and
we need some more details about what facts will be present, with what
priority they are chosen between sources when different information is
merged, and what queries to the reports endpoint will be acceptable.
That being said, this is a good start and gets the test cases in a
format so we can view them from our read the docs website.

Closes #95
Closes #94
Closes #98

camayoc/tests/qcs/api/v1/reports/__init__.py

@@ -0,0 +1,2 @@
+# coding=utf-8
+"""Tests for Quipucords reports."""

camayoc/tests/qcs/api/v1/reports/test_reports.py

@@ -0,0 +1,235 @@
+# coding=utf-8
+"""Tests for ``Reports`` API endpoint for quipucords server.
+
+:caseautomation: automated
+:casecomponent: api
+:caseimportance: high
+:caselevel: integration
+:requirement: Sonar
+:testtype: functional
+:upstream: yes
+"""
+
+import pytest
+
+
+@pytest.mark.skip
+def test_network(shared_client, cleanup, source):
+    """Confirm that reports are generated from network scans.
+
+    :id: 49cbba28-aa3c-425b-ad6a-1acf28530f81
+    :description: If a scan successfully generated fingerprints,
+        a report should be available associated with the fact
+        collection.
+    :steps:
+        1) Create a network source and associated credential
+        2) Create a scan of the sources
+        3) Assert that a report is available if the fingerprint was created.
+    :expectedresults: If a fingerprint can be made, a report is generated
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_vcenter(shared_client, cleanup, source):
+    """Confirm that reports are generated from vcenter scans.
+
+    :id: 7636b041-35d3-41d5-a37b-da645bd8356a
+    :description: If a scan successfully generated fingerprints,
+        a report should be available associated with the fact
+        collection.
+    :steps:
+        1) Create a vcenter source and associated credential
+        2) Create a scan of the sources
+        3) Assert that a report is available if the fingerprint was created.
+        4) Assert that the following facts are present:
+
+            * cluster name
+            * number of vmware hosts in cluster
+            * virtual sockets
+            * UUID (must be BIOS UUID)
+            * MAC address of interfaces
+            * Hostname
+            * IP address - note systems can have multiple IPs and could
+              potentially have the same IP as another system (NAT
+              environments)
+
+    :expectedresults: If a fingerprint can be made, a report is generated
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_satellite(shared_client, cleanup, source):
+    """Confirm that reports are generated from satellite scans.
+
+    :id: bcbb79d2-5963-4baf-87a4-1fd7861ae8f2
+    :description: If a scan successfully generated fingerprints,
+        a report should be available associated with the fact
+        collection.
+    :steps:
+        1) Create a satellite source and associated credential
+        2) Create a scan of the sources
+        3) Assert that a report is available if the fingerprint was created.
+        4) Assert that the following facts are present:
+
+            * Name (appears to be hostname)
+            * Subscription Name (string title of subscription)
+            * Amount (of subscription)
+            * Account #
+            * Contract #
+            * Start Date
+            * End Date
+            * BIOS Vendor
+            * BIOS Version
+            * BIOS Release Date
+            * System Manufacturer
+            * System Product Name
+            * Serial Number
+            * UUID
+            * Chassis Manufacturer
+            * Type
+            * Chassis Serial #
+            * Chassis Product Name
+
+    :expectedresults: If a fingerprint can be made, a report is generated and
+        contains expected facts.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_merge_network(shared_client, cleanup, source):
+    """Confirm that reports merge facts from network sources.
+
+    :id: 17cdb5ad-f083-471f-92e2-42f7a45c1c5a
+    :description: If a scan hits an entity multiple times in a single scan
+        job, it should merge the results in the report.
+    :steps:
+        1) Create a source and associated credential that specifies the same
+           machine with multiple IPs
+        2) Create a source that specifies the machine just once
+        3) Create scans of the sources
+        4) Assert that the reports are the same, as the one that hit
+           the machine multiple times should have merged the results
+    :expectedresults: Scan job results are merged into a report.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_merge_vcenter(shared_client, cleanup, source):
+    """Confirm that reports merge facts from vcenter sources.
+
+    :id: 5870750b-5eea-4e24-a720-21d5b33bca82
+    :description: If a scan finds the same machine  multiple times in a single
+        scan job from vcenter sources it should merge the results in the
+        report.
+    :steps:
+        1) Create multiple vcenter sources using the same vcenter
+        2) Create a scan that just scans the source once
+        3) Create a scan that scans all the sources (hitting the vcenter
+           multiple times.)
+        4) Assert that the report has the same number of machines as
+           it would have if it only scanned once.
+    :expectedresults: Scan job results are merged into a report.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_merge_types(shared_client, cleanup, source):
+    """Confirm that reports merge facts from all combinations of types.
+
+    :id: 9958509b-47a1-4d23-889f-9e8c067e705c
+    :description: If a scan finds the same machine via any combination of a
+        satellite source, a vcenter source, and a network source, data
+        related to the machine should be merged. This test is parameterized
+        on a network source and a vcenter where it is hosted and a satellite
+        with which it is registered.
+    :steps:
+        1) Create sources for all types used in permutation.
+        2) Create scan that uses all sources
+        3) Assert that no machine is reported twice
+    :expectedresults: Scan job results are merged into a report.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_redact(shared_client, cleanup, source):
+    """Confirm that I can request that facts be redacted in the report.
+
+    :id: 316554c3-d98a-46fb-bcad-fd5569bb603d
+    :description: A user should be able to query for a redacted report where
+        requested facts are obfuscated.
+    :steps: This functionality is not yet implemented.
+    :expectedresults: I can request that facts are redacted in a report.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_tag_hosts(shared_client, cleanup, source):
+    """Confirm that users can tag hosts with additional attributes.
+
+    :id: e9125267-0ea8-42e2-8bef-416bb0b85030
+    :description: Test that a user may somehow "tag" hosts with some kind of
+        "exclude" attribute so it can be excluded from Density and Time Series
+        reports.
+    :steps: This functionality is not yet implemented.
+    :expectedresults: Users have the ability to tag hosts with user defined
+        attributes and these can be used to change how reports are generated.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_density_report(shared_client, cleanup, source):
+    """Test that I may request a Denisty Report for each product.
+
+    :id: 23ab889b-3c47-42e6-a9db-288bde926c48
+    :description: For each product, I should be able to get a report from a
+        scan detailing how many machines were found with specified product.
+        Density reports should contain the following information:
+
+            * number of hosts
+            * number of virtual cores
+            * number of physical cores
+            * number of sockets
+            * number of socket pairs
+            * Version of product
+            * Report includes sum of virtual cores
+            * Report includes sum  of physical cores
+            * Report includes sum of sockets
+            * Report includes sum of socket pairs
+            * Report correctly differentiates between redhat and community
+              versions of product
+            * Report deduces from raw facts definitive version of rhel and
+              when it cannot deduce definitive version, it indicates this in
+              some way
+            * Report shows id of fact collection sourced from
+
+    :steps: This functionality is not yet implemented.
+    :expectedresults: Density reports provide data only about machines with
+        requested product.
+    :caseautomation: notautomated
+    """
+
+
+@pytest.mark.skip
+def test_time_series(shared_client, cleanup, source):
+    """Test that a user can request a time series report.
+
+    :id: 06823f56-760a-412f-b0a5-c33a19f511ca
+    :description: Test that for each product, I can generate a report that
+        takes in many fact collections given a start date and end date and
+        source and produces a report that shows how many {hosts, physical
+        cores, sockets, socket pairs, virtual cores} were found with that
+        product at each scan. Must allow some definition of “step value”,
+        i.e. period between fact collections to include.
+
+    :steps: This functionality is not yet implemented.
+    :expectedresults: Users can generate a time series report.
+    :caseautomation: notautomated
+    """

docs/api.rst

@@ -33,12 +33,13 @@ reference for developers, not a gospel.
     api/camayoc.tests.qcs.conftest.rst
     api/camayoc.tests.qcs.api.rst
     api/camayoc.tests.qcs.api.v1.rst
+    api/camayoc.tests.qcs.api.v1.authentication.test_login.rst
     api/camayoc.tests.qcs.api.v1.credentials.test_network_creds.rst
     api/camayoc.tests.qcs.api.v1.credentials.test_creds_common.rst
-    api/camayoc.tests.qcs.api.v1.sources.test_network_sources.rst
-    api/camayoc.tests.qcs.api.v1.sources.test_manager_sources.rst
-    api/camayoc.tests.qcs.api.v1.sources.test_sources_common.rst
+    api/camayoc.tests.qcs.api.v1.reports.test_reports.rst
     api/camayoc.tests.qcs.api.v1.scans.test_network_scans.rst
     api/camayoc.tests.qcs.api.v1.scans.test_satellite_scans.rst
     api/camayoc.tests.qcs.api.v1.scans.test_vcenter_scans.rst
-    api/camayoc.tests.qcs.api.v1.authentication.test_login.rst
+    api/camayoc.tests.qcs.api.v1.sources.test_network_sources.rst
+    api/camayoc.tests.qcs.api.v1.sources.test_manager_sources.rst
+    api/camayoc.tests.qcs.api.v1.sources.test_sources_common.rst

docs/api/camayoc.tests.qcs.api.v1.reports.rst

@@ -0,0 +1,15 @@
+camayoc\.tests\.qcs\.api\.v1\.reports package
+=============================================
+
+.. automodule:: camayoc.tests.qcs.api.v1.reports
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   camayoc.tests.qcs.api.v1.reports.test_reports
+

docs/api/camayoc.tests.qcs.api.v1.reports.test_reports.rst

@@ -0,0 +1,7 @@
+camayoc\.tests\.qcs\.api\.v1\.reports\.test\_reports module
+===========================================================
+
+.. automodule:: camayoc.tests.qcs.api.v1.reports.test_reports
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/camayoc.tests.qcs.api.v1.rst

@@ -13,6 +13,7 @@ Subpackages
 
     camayoc.tests.qcs.api.v1.authentication
     camayoc.tests.qcs.api.v1.credentials
+    camayoc.tests.qcs.api.v1.reports
     camayoc.tests.qcs.api.v1.scans
     camayoc.tests.qcs.api.v1.sources