test_mass_downloader.py

# -*- coding: utf-8 -*-
"""
The obspy.clients.fdsn.download_helpers test suite.

:copyright:
    Lion Krischer (krischer@geophysik.uni-muenchen.de), 2014-2105
:license:
    GNU Lesser General Public License, Version 3
    (https://www.gnu.org/copyleft/lesser.html)
"""
import collections
import copy
import logging
import os
import shutil
import sys
import tempfile
from socket import timeout as socket_timeout
from unittest import mock

import pytest

if sys.version_info.major == 2:
    from httplib import HTTPException
else:
    from http.client import HTTPException

import numpy as np

import obspy
from obspy.core.util.base import NamedTemporaryFile
from obspy.clients.fdsn import Client
from obspy.clients.fdsn.mass_downloader import (domain, Restrictions,
                                                MassDownloader)
from obspy.clients.fdsn.mass_downloader.utils import (
    filter_channel_priority, get_stationxml_filename, get_mseed_filename,
    get_stationxml_contents, SphericalNearestNeighbour, safe_delete,
    download_stationxml, download_and_split_mseed_bulk,
    _get_stationxml_contents_slow)
from obspy.clients.fdsn.mass_downloader.download_helpers import (
    Channel, TimeInterval, Station, STATUS, ClientDownloadHelper)


pytestmark = pytest.mark.network


class TestDomain():
    """
    Test case for the domain definitions.
    """
    def test_rectangular_domain(self):
        """
        Test the rectangular domain.
        """
        dom = domain.RectangularDomain(-10, 10, -20, 20)
        query_params = dom.get_query_parameters()
        assert query_params == {
            "minlatitude": -10,
            "maxlatitude": 10,
            "minlongitude": -20,
            "maxlongitude": 20}

        # The rectangular domain is completely defined by the query parameters.
        with pytest.raises(NotImplementedError):
            dom.is_in_domain(0, 0)

    def test_circular_domain(self):
        """
        Test the circular domain.
        """
        dom = domain.CircularDomain(10, 20, 30, 40)
        query_params = dom.get_query_parameters()
        assert query_params == {
            "latitude": 10,
            "longitude": 20,
            "minradius": 30,
            "maxradius": 40}

        # The circular domain is completely defined by the query parameters.
        with pytest.raises(NotImplementedError):
            dom.is_in_domain(0, 0)

    def test_global_domain(self):
        """
        Test the global domain.
        """
        dom = domain.GlobalDomain()
        query_params = dom.get_query_parameters()
        assert query_params == {}

        # Obviously every point is in the domain.
        with pytest.raises(NotImplementedError):
            dom.is_in_domain(0, 0)

    def test_subclassing_without_abstract_method(self):
        """
        Subclassing without implementing the get_query_parameters method
        results in a TypeError upon instantiation time.
        """
        class NewDom(domain.Domain):
            pass

        with pytest.raises(TypeError):
            NewDom()

    def test_instantiating_root_domain_object_fails(self):
        """
        Trying to create a root domain object should fail.
        """
        with pytest.raises(TypeError):
            domain.Domain()


class TestRestrictions():
    """
    Test case for the restrictions object.
    """
    def test_passing_string_as_priority_list_raises(self):
        """
        Users reported errors as they used "tuples" with single items as
        priority lists. Python semantics mean that a "tuple" without a comma
        is not tuple. Thus '("HH[NEZ")' is actually just a string which is
        not what the users expected. Thus this should raise an exception.
        """
        start = obspy.UTCDateTime(2014, 1, 1)
        end = start + 10

        # Test for the channel_priorities key.
        msg = ("'channel_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         channel_priorities="HHE")

        msg = ("'channel_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         channel_priorities=("HHE"))

        msg = ("'channel_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         channel_priorities="HHE")

        msg = ("'channel_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         channel_priorities="HHE")

        # And for the location priorities key.
        msg = ("'location_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         location_priorities="00")

        msg = ("'location_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         location_priorities=("00"))

        msg = ("'location_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         location_priorities="00")

        msg = ("'location_priorities' must be a list or other iterable "
               "container.")
        with pytest.raises(TypeError, match=msg):
            Restrictions(starttime=start, endtime=end,
                         location_priorities=("00"))

        # All other valid things should of course still work.
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=("HHE",))
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=["HHE"])
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=("HHE", "BHE"))
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=["HHE", "BHE"])
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=("HHE",))
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=["HHE"])
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=("HHE",
                                         "BHE"))
        Restrictions(starttime=start, endtime=end,
                     channel_priorities=["HHE",
                                         "BHE"])
        Restrictions(starttime=start, endtime=end,
                     location_priorities=("00",))
        Restrictions(starttime=start, endtime=end,
                     location_priorities=["00"])
        Restrictions(starttime=start, endtime=end,
                     location_priorities=("00", "10"))
        Restrictions(starttime=start, endtime=end,
                     location_priorities=["00", "10"])
        Restrictions(starttime=start, endtime=end,
                     location_priorities=("00",))
        Restrictions(starttime=start, endtime=end,
                     location_priorities=["00"])
        Restrictions(starttime=start, endtime=end,
                     location_priorities=("00",
                                          "10"))
        Restrictions(starttime=start, endtime=end,
                     location_priorities=["00",
                                          "10"])

    def test_restrictions_object(self):
        """
        Tests the restrictions object.
        """
        start = obspy.UTCDateTime(2014, 1, 1)
        res = Restrictions(starttime=start, endtime=start + 10)

        # No chunklength means it should just return one item.
        chunks = list(res)
        assert len(chunks) == 1
        assert chunks[0] == (start, start + 10)

        # One with chunklength should return the chunked pieces.
        res = Restrictions(starttime=start, endtime=start + 10,
                           chunklength_in_sec=1)
        chunks = list(res)
        assert len(chunks) == 10
        assert [_i[0] for _i in chunks] == \
            [start + _i * 1 for _i in range(10)]
        assert [_i[1] for _i in chunks] == \
            [start + _i * 1 for _i in range(1, 11)]
        assert chunks[0][0] == start
        assert chunks[-1][1] == start + 10

        # Make sure the last piece is cut if it needs to be.
        start = obspy.UTCDateTime(2012, 1, 1)
        end = obspy.UTCDateTime(2012, 2, 1)
        res = Restrictions(starttime=start, endtime=end,
                           chunklength_in_sec=86400 * 10)
        chunks = list(res)
        assert chunks == [
            (start, start + 86400 * 10),
            (start + 86400 * 10, start + 86400 * 20),
            (start + 86400 * 20, start + 86400 * 30),
            (start + 86400 * 30, end)]

        # No station start-and endtime by default
        res = Restrictions(starttime=start, endtime=start + 10)
        assert res.station_starttime is None
        assert res.station_endtime is None

        # One can only set one of the two.
        res = Restrictions(starttime=start, endtime=start + 10,
                           station_starttime=start - 10)
        assert res.station_starttime == start - 10
        assert res.station_endtime is None

        res = Restrictions(starttime=start, endtime=start + 10,
                           station_endtime=start + 20)
        assert res.station_starttime is None
        assert res.station_endtime == start + 20

        # Will raise a ValueError if either within the time interval of the
        # normal start- and endtime.
        with pytest.raises(ValueError):
            Restrictions(starttime=start,
                         endtime=start + 10, station_starttime=start + 1)

        with pytest.raises(ValueError):
            Restrictions(starttime=start,
                         endtime=start + 10, station_endtime=start + 9)

        # Fine if they are equal with both.
        Restrictions(starttime=start, endtime=start + 10,
                     station_starttime=start, station_endtime=start + 10)

    def test_inventory_parsing(self, testdata):
        """
        Test the inventory parsing if an inventory is given.
        """
        # Nothing is given.
        r = Restrictions(starttime=obspy.UTCDateTime(2011, 1, 1),
                         endtime=obspy.UTCDateTime(2011, 2, 1))
        assert r.limit_stations_to_inventory is None

        # An inventory object is given.
        inv = obspy.read_inventory(testdata["channel_level_fdsn.txt"])
        r = Restrictions(starttime=obspy.UTCDateTime(2011, 1, 1),
                         endtime=obspy.UTCDateTime(2011, 2, 1),
                         limit_stations_to_inventory=inv)
        assert {("AK", "BAGL"), ("AK", "BWN"), ("AZ", "BZN")} == \
            r.limit_stations_to_inventory


class TestDownloadHelpersUtil():
    """
    Test cases for utility functionality for the download helpers.
    """
    def test_channel_priority_filtering(self):
        """
        Tests the channel priority filtering.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60)
            for _i in range(10)]
        c1 = Channel("", "BHE", time_intervals)
        c2 = Channel("10", "SHE", time_intervals)
        c3 = Channel("00", "BHZ", time_intervals)
        c4 = Channel("", "HHE", time_intervals)
        c5 = Channel("", "ELZ", time_intervals)
        channels = [c1, c2, c3, c4, c5]

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=[
                "HH[ZNE]", "BH[ZNE]", "MH[ZNE]", "EH[ZNE]",
                "LH[ZNE]"])
        assert filtered_channels == [c4]

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=[
                "BH[ZNE]", "MH[ZNE]", "EH[ZNE]", "LH[ZNE]"])
        assert filtered_channels == [c1, c3]

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=["LH[ZNE]"])
        assert filtered_channels == []

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=["*"])
        assert filtered_channels == channels

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=[
                "BH*", "MH[ZNE]", "EH[ZNE]", "LH[ZNE]"])
        assert filtered_channels == [c1, c3]

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=[
                "BH[NZ]", "MH[ZNE]", "EH[ZNE]", "LH[ZNE]"])
        assert filtered_channels == [c3]

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=["S*", "BH*"])
        assert filtered_channels == [c2]

        # Different ways to not filter.
        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=["*"])
        assert filtered_channels == channels

        filtered_channels = filter_channel_priority(
            channels, key="channel", priorities=None)
        assert filtered_channels == channels

    def test_location_priority_filtering(self):
        """
        Tests the channel priority filtering.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60)
            for _i in range(10)]
        c1 = Channel("", "BHE", time_intervals)
        c2 = Channel("10", "SHE", time_intervals)
        c3 = Channel("00", "BHZ", time_intervals)
        c4 = Channel("", "HHE", time_intervals)
        channels = [c1, c2, c3, c4]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["*0"])
        assert filtered_channels == [c2, c3]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["00"])
        assert filtered_channels == [c3]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=[""])
        assert filtered_channels == [c1, c4]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["1?"])
        assert filtered_channels == [c2]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["", "*0"])
        assert filtered_channels == [c1, c4]

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["*0", ""])
        assert filtered_channels == [c2, c3]

        # Different ways to not filter.
        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=["*"])
        assert filtered_channels == channels

        filtered_channels = filter_channel_priority(
            channels, key="location", priorities=None)
        assert filtered_channels == channels

    def test_spherical_nearest_neighbour(self):
        """
        Tests the spherical kd-tree.
        """
        # Get the distance of a point to itself.
        point = Station("", "", 10.0, 20.0, [])
        tree = SphericalNearestNeighbour(data=[point])
        result = tree.query(points=[point])
        distance, indices = result[0][0], result[1][0]
        np.testing.assert_allclose(distance, [0])
        np.testing.assert_allclose(indices, [0])

        # Two points, one 50 km, the other 150 km distant.
        point_a = Station("", "", 0.0, -0.5, [])
        point_b = Station("", "", 0.0, 1.5, [])
        tree = SphericalNearestNeighbour(data=[point_a, point_b])
        result = tree.query(points=[Station("", "", 0.0, 0.0, [])])
        distance, indices = result[0][0], result[1][0]

        np.testing.assert_allclose(distance, [55597.36],
                                   atol=1, rtol=1E-5)
        np.testing.assert_allclose(indices, [0])

        # Query pairs.
        point_a = Station("", "", 0.0, -0.5, [])
        point_b = Station("", "", 0.0, 1.5, [])
        point_c = Station("", "", 0.0, 0.0, [])
        tree = SphericalNearestNeighbour(data=[point_a, point_b, point_c])
        # 100 km apart. Only contains points a and c.
        assert tree.query_pairs(100000) == {(0, 2)}

    def test_safe_delete(self):
        """
        Test the safe-delete function.
        """
        dir = tempfile.mkdtemp()
        try:
            # If the file does not exist, nothing happens.
            safe_delete(os.path.join(dir, "non-existant"))
            # If not a file, an error will be raised.
            name = os.path.join(dir, "tmpdir")
            os.makedirs(name)
            with pytest.raises(ValueError):
                safe_delete(name)
            # Otherwise it can delete a file just fine.
            name = os.path.join(dir, "tmpfile")
            with open(name, "wt") as fh:
                fh.write("0")
            assert os.path.exists(name)
            safe_delete(name)
            assert not os.path.exists(name)

        finally:
            shutil.rmtree(dir)

    def test_download_stationxml(self):
        """
        Mock test for the StationXML downloading.

        Does not do much and is not a proper test but it's something and
        makes sure there is not obvious logic error.
        """
        bulk = [
            ["BW", "ALTM"],
            ["BW", "ALTM"],
        ]
        filename = "temp.xml"
        client_name = "mock"

        client = mock.MagicMock()
        logger = mock.MagicMock()

        # Normal call.
        ret_val = download_stationxml(client, client_name, bulk, filename,
                                      logger)
        assert ret_val == (("BW", "ALTM"), filename)

        assert logger.info.call_count == 1
        assert logger.info.call_args[0][0] == \
            "Client 'mock' - Successfully downloaded 'temp.xml'."
        assert client.get_stations_bulk.call_count == 1
        assert client.get_stations_bulk.call_args[1]["bulk"] == bulk
        assert client.get_stations_bulk.call_args[1]["level"] == "response"
        assert client.get_stations_bulk.call_args[1]["filename"] == filename

        # Call that raises.
        client.reset_mock()
        logger.reset_mock()

        def raise_exception():
            raise ValueError("Test")
        client.get_stations_bulk.side_effect = raise_exception

        ret_val = download_stationxml(client, client_name, bulk, filename,
                                      logger)
        assert ret_val is None

        assert logger.info.call_count == 1
        assert logger.info.call_args[0][0] == \
            "Failed to download StationXML from 'mock' for station 'BW.ALTM'."
        assert client.get_stations_bulk.call_count == 1
        assert client.get_stations_bulk.call_args[1]["bulk"] == bulk
        assert client.get_stations_bulk.call_args[1]["level"] == "response"
        assert client.get_stations_bulk.call_args[1]["filename"] == filename

    def test_download_and_split_mseed(self):
        """
        Largely mocked test for the download_and_split_mseed() function.
        """
        client_name = "mock"

        client = mock.MagicMock()
        logger = mock.MagicMock()

        def get_waveforms_bulk_mock(bulk, filename):
            """
            Actually create the requested MiniSEED file.
            """
            st = obspy.Stream()
            for item in bulk:
                tr = obspy.Trace()
                tr.stats.network = item[0]
                tr.stats.station = item[1]
                tr.stats.location = item[2]
                tr.stats.channel = item[3]
                tr.stats.starttime = item[4]
                tr.stats.delta = 1.0
                tr.data = np.empty(int(item[5] - item[4]) + 1)
                st.traces.append(tr)

            st.write(filename, format="mseed")

        client.get_waveforms_bulk.side_effect = get_waveforms_bulk_mock

        tmpdir = tempfile.mkdtemp()

        try:
            chunks = [
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_1.mseed")],
                ["BW", "ALTM", "", "EHN", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_2.mseed")],
                ["BW", "ALTM", "", "EHZ", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_3.mseed")],
            ]
            ret_val = download_and_split_mseed_bulk(
                client=client, client_name=client_name, chunks=chunks,
                logger=logger)

            contents = [("file_1.mseed", "BW.ALTM..EHE"),
                        ("file_2.mseed", "BW.ALTM..EHN"),
                        ("file_3.mseed", "BW.ALTM..EHZ")]

            assert ret_val == sorted([os.path.join(tmpdir, _i[0])
                                      for _i in contents])

            # Make sure all files have been written.
            assert sorted(os.listdir(tmpdir)) == \
                ["file_1.mseed", "file_2.mseed", "file_3.mseed"]
            # Check the actual files.
            for filename, id, in contents:
                st = obspy.read(os.path.join(tmpdir, filename))
                assert len(st) == 1
                tr = st[0]
                assert tr.id == id
                assert tr.stats.starttime == obspy.UTCDateTime(0)
                assert tr.stats.endtime == obspy.UTCDateTime(10)

        finally:
            shutil.rmtree(tmpdir)

        # Same as before but now add some random other things so make sure
        # they get filtered out.
        client.reset_mock()
        logger.reset_mock()

        def get_waveforms_bulk_mock(bulk, filename):
            """
            Actually create the requested MiniSEED file.
            """
            st = obspy.Stream()
            for item in bulk:
                tr = obspy.Trace()
                tr.stats.network = item[0]
                tr.stats.station = item[1]
                tr.stats.location = item[2]
                tr.stats.channel = item[3]
                tr.stats.starttime = item[4]
                tr.stats.delta = 1.0
                tr.data = np.empty(int(item[5] - item[4]) + 1)
                st.traces.append(tr)

            # Add some random other stuff to mess with things.
            tr = obspy.Trace()
            tr.stats.network = "HM"
            tr.stats.channel = "EHE"
            tr.data = np.empty(12)
            st.traces.append(tr)

            tr = obspy.Trace()
            tr.stats.network = "HM"
            tr.stats.channel = "BHE"
            tr.data = np.empty(12)
            st.traces.append(tr)

            # This time same id as above, but different time span.
            tr = obspy.Trace()
            tr.stats.network = bulk[0][0]
            tr.stats.station = bulk[0][1]
            tr.stats.location = bulk[0][2]
            tr.stats.channel = bulk[0][3]
            tr.data = np.empty(34)
            tr.stats.starttime += 1234567.345
            st.traces.append(tr)

            st.write(filename, format="mseed")

        client.get_waveforms_bulk.side_effect = get_waveforms_bulk_mock

        tmpdir = tempfile.mkdtemp()

        try:
            chunks = [
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_1.mseed")],
                ["BW", "ALTM", "", "EHN", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_2.mseed")],
                ["BW", "ALTM", "", "EHZ", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(10), os.path.join(tmpdir, "file_3.mseed")],
            ]
            ret_val = download_and_split_mseed_bulk(
                client=client, client_name=client_name, chunks=chunks,
                logger=logger)

            contents = [("file_1.mseed", "BW.ALTM..EHE"),
                        ("file_2.mseed", "BW.ALTM..EHN"),
                        ("file_3.mseed", "BW.ALTM..EHZ")]

            assert ret_val == sorted([os.path.join(tmpdir, _i[0])
                                      for _i in contents])

            # Make sure all files have been written.
            assert sorted(os.listdir(tmpdir)) == \
                ["file_1.mseed", "file_2.mseed", "file_3.mseed"]
            # Check the actual files.
            for filename, id, in contents:
                st = obspy.read(os.path.join(tmpdir, filename))
                assert len(st) == 1
                tr = st[0]
                assert tr.id == id
                assert tr.stats.starttime == obspy.UTCDateTime(0)
                assert tr.stats.endtime == obspy.UTCDateTime(10)

        finally:
            shutil.rmtree(tmpdir)

        # Now simulate a request of lots of data from the same channel.
        client.reset_mock()
        logger.reset_mock()

        def get_waveforms_bulk_mock(bulk, filename):
            """
            Actually create the requested MiniSEED file.
            """
            st = obspy.Stream()
            for item in bulk:
                tr = obspy.Trace()
                tr.stats.network = item[0]
                tr.stats.station = item[1]
                tr.stats.location = item[2]
                tr.stats.channel = item[3]
                tr.stats.starttime = item[4]
                tr.stats.delta = 1.0
                tr.data = np.empty(int(item[5] - item[4]) + 1)
                st.traces.append(tr)

            st.write(filename, format="mseed")

        client.get_waveforms_bulk.side_effect = get_waveforms_bulk_mock

        tmpdir = tempfile.mkdtemp()

        try:
            chunks = [
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(1E5), os.path.join(tmpdir, "file_1.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(1E5),
                 obspy.UTCDateTime(2E5), os.path.join(tmpdir, "file_2.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(2E5),
                 obspy.UTCDateTime(3E5), os.path.join(tmpdir, "file_3.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(3E5),
                 obspy.UTCDateTime(4E5), os.path.join(tmpdir, "file_4.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(4E5),
                 obspy.UTCDateTime(5E5), os.path.join(tmpdir, "file_5.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(6E5),
                 obspy.UTCDateTime(7E5), os.path.join(tmpdir, "file_6.mseed")]
            ]
            ret_val = download_and_split_mseed_bulk(
                client=client, client_name=client_name, chunks=chunks,
                logger=logger)

            # Now five files but all the same channel.
            contents = [("file_1.mseed", "BW.ALTM..EHE"),
                        ("file_2.mseed", "BW.ALTM..EHE"),
                        ("file_3.mseed", "BW.ALTM..EHE"),
                        ("file_4.mseed", "BW.ALTM..EHE"),
                        ("file_5.mseed", "BW.ALTM..EHE"),
                        ("file_6.mseed", "BW.ALTM..EHE")]

            assert ret_val == sorted([os.path.join(tmpdir, _i[0])
                                      for _i in contents])

            # Make sure all files have been written.
            assert sorted(os.listdir(tmpdir)) == [_i[0] for _i in contents]

            # The interesting thing here is that it should only send a
            # request for single time span and then split again on the
            # client side. Here is two time spans as one segment is further
            # away.
            call_args = client.get_waveforms_bulk.call_args[0][0]
            assert call_args == [
                    ['BW', 'ALTM', '', 'EHE', obspy.UTCDateTime(0),
                     obspy.UTCDateTime(5E5)],
                    ['BW', 'ALTM', '', 'EHE', obspy.UTCDateTime(6E5),
                     obspy.UTCDateTime(7E5)]]

        finally:
            shutil.rmtree(tmpdir)

        # Last one attempting to get overlapping filenames.
        client.reset_mock()
        logger.reset_mock()

        def get_waveforms_bulk_mock(bulk, filename):
            """
            Actually create the requested MiniSEED file.
            """
            st = obspy.Stream()
            for item in bulk:
                tr = obspy.Trace()
                tr.stats.network = item[0]
                tr.stats.station = item[1]
                tr.stats.location = item[2]
                tr.stats.channel = item[3]
                tr.stats.starttime = item[4]
                tr.stats.delta = 1.0
                tr.data = np.empty(int(item[5] - item[4]) + 1)
                st.traces.append(tr)

            st.write(filename, format="mseed")

        client.get_waveforms_bulk.side_effect = get_waveforms_bulk_mock

        tmpdir = tempfile.mkdtemp()

        try:
            chunks = [
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(0),
                 obspy.UTCDateTime(1E5), os.path.join(tmpdir, "file_1.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(0.4E5),
                 obspy.UTCDateTime(1.6E5),
                 os.path.join(tmpdir, "file_2.mseed")],
                ["BW", "ALTM", "", "EHE", obspy.UTCDateTime(1.2E5),
                 obspy.UTCDateTime(2.2E5),
                 os.path.join(tmpdir, "file_3.mseed")]]
            ret_val = download_and_split_mseed_bulk(
                client=client, client_name=client_name, chunks=chunks,
                logger=logger)

            contents = [("file_1.mseed", "BW.ALTM..EHE"),
                        ("file_2.mseed", "BW.ALTM..EHE"),
                        ("file_3.mseed", "BW.ALTM..EHE")]

            assert ret_val == sorted([os.path.join(tmpdir, _i[0])
                                      for _i in contents])

            # Make sure all files have been written.
            assert sorted(os.listdir(tmpdir)) == \
                ["file_1.mseed", "file_2.mseed", "file_3.mseed"]
            # Check the actual files. There will be no overlap of data in
            # the files but the data should be distributed across
            # files according to some heuristics.
            st = obspy.read(os.path.join(tmpdir, "file_1.mseed"))
            assert len(st) == 1
            tr = st[0]
            assert tr.id == "BW.ALTM..EHE"
            assert tr.stats.starttime == obspy.UTCDateTime(0)
            # Record length of 512.
            assert abs(tr.stats.endtime - obspy.UTCDateTime(1E5)) < 512

            st = obspy.read(os.path.join(tmpdir, "file_2.mseed"))
            assert len(st) == 1
            tr = st[0]
            assert tr.id == "BW.ALTM..EHE"
            # Record length of 512.
            assert abs(tr.stats.starttime - obspy.UTCDateTime(1E5)) < 512
            assert abs(tr.stats.endtime - obspy.UTCDateTime(1.6E5)) < 512

            st = obspy.read(os.path.join(tmpdir, "file_3.mseed"))
            assert len(st) == 1
            tr = st[0]
            assert tr.id == "BW.ALTM..EHE"
            # Record length of 512.
            assert abs(tr.stats.starttime - obspy.UTCDateTime(1.6E5)) < 512
            # End time is exact again as no more overlaps occur.
            assert tr.stats.endtime == obspy.UTCDateTime(2.2E5)

        finally:
            shutil.rmtree(tmpdir)

    def test_stationxml_filename_helper(self):
        """
        Tests the get_stationxml_filename() function.
        """
        c1 = ("", "BHE")
        c2 = ("10", "SHE")
        starttime = obspy.UTCDateTime(2012, 1, 1)
        endtime = obspy.UTCDateTime(2012, 1, 2)
        channels = [c1, c2]

        # A normal string is considered a path.
        assert get_stationxml_filename(
            "FOLDER", network="BW", station="FURT", channels=channels,
            starttime=starttime, endtime=endtime) == \
            os.path.join("FOLDER", "BW.FURT.xml")
        assert get_stationxml_filename(
            "stations", network="BW", station="FURT", channels=channels,
            starttime=starttime, endtime=endtime) == \
            os.path.join("stations", "BW.FURT.xml")

        # Passing a format string causes it to be used.
        assert get_stationxml_filename(
            "{network}_{station}.xml", network="BW", station="FURT",
            channels=channels, starttime=starttime, endtime=endtime) == \
            "BW_FURT.xml"
        assert get_stationxml_filename(
            "TEMP/{network}/{station}.xml", network="BW", station="FURT",
            channels=channels, starttime=starttime, endtime=endtime) == \
            "TEMP/BW/FURT.xml"

        # A passed function will be executed. A string should just be returned.
        def get_name(network, station, channels, starttime, endtime):
            return "network" + "__" + station
        assert get_stationxml_filename(
            get_name, network="BW", station="FURT", channels=channels,
            starttime=starttime, endtime=endtime) == "network__FURT"

        # A dictionary with certain keys is also acceptable.
        def get_name(network, station, channels, starttime, endtime):
            return {"missing_channels": [c1],
                    "available_channels": [c2],
                    "filename": "test.xml"}
        assert get_stationxml_filename(
            get_name, network="BW", station="FURT", channels=channels,
            starttime=starttime, endtime=endtime) == \
            {"missing_channels": [c1], "available_channels": [c2],
             "filename": "test.xml"}

        # Missing keys raise.
        def get_name(network, station, channels, starttime, endtime):
            return {"missing_channels": [c1],
                    "available_channels": [c2]}
        with pytest.raises(ValueError):
            get_stationxml_filename(
                get_name, "BW", "FURT", channels, starttime, endtime)

        # Wrong value types should also raise.
        def get_name(network, station, channels, starttime, endtime):
            return {"missing_channels": [c1], "available_channels": [c2],
                    "filename": True}
        with pytest.raises(ValueError):
            get_stationxml_filename(
                get_name, "BW", "FURT", channels, starttime, endtime)

        def get_name(network, station, channels, starttime, endtime):
            return {"missing_channels": True,
                    "available_channels": [c2],
                    "filename": "test.xml"}
        with pytest.raises(ValueError):
            get_stationxml_filename(
                get_name, "BW", "FURT", channels, starttime, endtime)

        def get_name(network, station, channels, starttime, endtime):
            return {"missing_channels": [c1],
                    "available_channels": True,
                    "filename": "test.xml"}
        with pytest.raises(ValueError):
            get_stationxml_filename(
                get_name, "BW", "FURT", channels, starttime, endtime)

        # It will raise a type error, if the function does not return the
        # proper type.
        with pytest.raises(TypeError):
            get_stationxml_filename(
                lambda x: 1, "BW", "FURT", starttime, endtime)

    def test_mseed_filename_helper(self):
        """
        Tests the get_mseed_filename() function.
        """
        starttime = obspy.UTCDateTime(2014, 1, 2, 3, 4, 5)
        endtime = obspy.UTCDateTime(2014, 2, 3, 4, 5, 6)

        # A normal string is considered a path.
        assert get_mseed_filename(
            "FOLDER", network="BW", station="FURT", location="", channel="BHE",
            starttime=starttime, endtime=endtime) == \
            os.path.join(
                "FOLDER", "BW.FURT..BHE__20140102T030405Z__"
                "20140203T040506Z.mseed")
        assert get_mseed_filename(
            "waveforms", network="BW", station="FURT", location="00",
            channel="BHE", starttime=starttime, endtime=endtime) == \
            os.path.join("waveforms", "BW.FURT.00.BHE__20140102T030405Z__"
                         "20140203T040506Z.mseed")

        # Passing a format string causes it to be used.
        assert get_mseed_filename(
            "{network}_{station}_{location}_{channel}_"
            "{starttime}_{endtime}.ms", network="BW", station="FURT",
            location="", channel="BHE", starttime=starttime,
            endtime=endtime) == \
            "BW_FURT__BHE_20140102T030405Z_20140203T040506Z.ms"
        assert get_mseed_filename(
            "{network}_{station}_{location}_{channel}_"
            "{starttime}_{endtime}.ms", network="BW", station="FURT",
            location="00", channel="BHE", starttime=starttime,
            endtime=endtime) == \
            "BW_FURT_00_BHE_20140102T030405Z_20140203T040506Z.ms"

        # A passed function will be executed.
        def get_name(network, station, location, channel, starttime, endtime):
            if network == "AH":
                return True
            return "network" + "__" + station + location + channel

        # Returning a filename is possible.
        assert get_mseed_filename(
            get_name, network="BW", station="FURT", location="", channel="BHE",
            starttime=starttime, endtime=endtime) == "network__FURTBHE"
        # 'True' can also be returned. This indicates that the file already
        # exists.
        assert get_mseed_filename(
            get_name, network="AH", station="FURT", location="", channel="BHE",
            starttime=starttime, endtime=endtime) is True

        # It will raise a type error, if the function does not return the
        # proper type.
        with pytest.raises(TypeError):
            get_mseed_filename(lambda x: 1, "BW", "FURT", "", "BHE")

    def test_get_stationxml_contents(self, testdata):
        """
        Tests the fast get_stationxml_contents() function.
        """
        ChannelAvailability = collections.namedtuple(
            "ChannelAvailability",
            ["network", "station", "location", "channel", "starttime",
             "endtime", "filename"])

        # Read with ObsPy and the fast variant.
        inv = obspy.read_inventory(testdata["AU.MEEK.xml"])
        # Consistency test.
        assert len(inv.networks) == 1
        contents = get_stationxml_contents(testdata["AU.MEEK.xml"])
        net = inv[0]
        sta = net[0]
        cha = sta[0]
        assert contents == \
            [ChannelAvailability(net.code, sta.code, cha.location_code,
                                 cha.code, cha.start_date, cha.end_date,
                                 testdata["AU.MEEK.xml"])]

    def test_fast_vs_slow_get_stationxml_contents(self, testdata):
        """
        Both should of course return the same result.

        For some old lxml versions both will be using the same function,
        but this is still a useful test.
        """
        assert get_stationxml_contents(testdata["AU.MEEK.xml"]) == \
            _get_stationxml_contents_slow(testdata["AU.MEEK.xml"])

    def test_channel_str_representation(self):
        """
        Test the string representations of channel objects.
        """
        # Single interval.
        intervals = [TimeInterval(
            obspy.UTCDateTime(2012, 1, 1), obspy.UTCDateTime(2012, 2, 1),
            filename=None, status=None)]
        c = Channel(location="", channel="BHE", intervals=intervals)
        assert str(c) == (
            "Channel '.BHE':\n"
            "\tTimeInterval(start=UTCDateTime(2012, 1, 1, 0, 0), "
            "end=UTCDateTime(2012, 2, 1, 0, 0), filename=None, "
            "status='none')")


class TestTimeInterval():
    """
    Test cases for the TimeInterval class.
    """
    def test_repr(self):
        st = obspy.UTCDateTime(2012, 1, 1)
        et = obspy.UTCDateTime(2012, 1, 2)
        ti = TimeInterval(st, et)
        assert repr(ti) == \
            "TimeInterval(start=UTCDateTime(2012, 1, 1, 0, 0), " \
            "end=UTCDateTime(2012, 1, 2, 0, 0), filename=None, status='none')"

        st = obspy.UTCDateTime(2012, 1, 1)
        et = obspy.UTCDateTime(2012, 1, 2)
        ti = TimeInterval(st, et, filename="dummy.txt")
        assert repr(ti) == \
            "TimeInterval(start=UTCDateTime(2012, 1, 1, 0, 0), " \
            "end=UTCDateTime(2012, 1, 2, 0, 0), filename='dummy.txt', " \
            "status='none')"

        st = obspy.UTCDateTime(2012, 1, 1)
        et = obspy.UTCDateTime(2012, 1, 2)
        ti = TimeInterval(st, et, filename="dummy.txt", status=STATUS.IGNORE)
        assert repr(ti) == \
            "TimeInterval(start=UTCDateTime(2012, 1, 1, 0, 0), " \
            "end=UTCDateTime(2012, 1, 2, 0, 0), filename='dummy.txt', " \
            "status='ignore')"


class TestChannel():
    """
    Test cases for the Channel class.
    """
    def test_temporal_bounds(self):
        """
        Tests the temporal bounds retrieval.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c = Channel(location="", channel="BHZ", intervals=time_intervals)
        assert c.temporal_bounds == (st, st + 10 * 60)

    def test_wants_station_information(self):
        """
        Tests the wants station information property.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c = Channel(location="", channel="BHZ", intervals=time_intervals)

        # Right now all intervals have status NONE.
        assert not c.needs_station_file

        # As soon as at least one interval has status DOWNLOADED or EXISTS,
        # a station file is required.
        c.intervals[1].status = STATUS.EXISTS
        assert c.needs_station_file
        c.intervals[1].status = STATUS.DOWNLOADED
        assert c.needs_station_file

        # Any other status does not trigger the need to download.
        c.intervals[1].status = STATUS.DOWNLOAD_REJECTED
        assert not c.needs_station_file


class TestStation():
    """
    Test cases for the Station class.
    """
    def test_has_existing_or_downloaded_time_intervals(self):
        """
        Tests for the property that tests for existing or downloaded time
        intervals.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.copy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.copy(time_intervals))
        channels = [c1, c2]

        # False per default.
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)
        assert not station.has_existing_or_downloaded_time_intervals

        # Changing one interval to DOWNLOADED affects the whole station.
        station.channels[0].intervals[0].status = STATUS.DOWNLOADED
        assert station.has_existing_or_downloaded_time_intervals

        # Same with EXISTS.
        station.channels[0].intervals[0].status = STATUS.EXISTS
        assert station.has_existing_or_downloaded_time_intervals

        # Changing back.
        station.channels[0].intervals[0].status = STATUS.NONE
        assert not station.has_existing_or_downloaded_time_intervals

    def test_has_existing_time_intervals(self):
        """
        Tests for the property that tests for existing time intervals.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.copy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.copy(time_intervals))
        channels = [c1, c2]

        # False by default.
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)
        assert not station.has_existing_time_intervals

        # Changing one interval to DOWNLOADED does not do anything
        station.channels[0].intervals[0].status = STATUS.DOWNLOADED
        assert not station.has_existing_time_intervals

        # EXISTS on the other hand does.
        station.channels[0].intervals[0].status = STATUS.EXISTS
        assert station.has_existing_time_intervals

        # Changing back.
        station.channels[0].intervals[0].status = STATUS.NONE
        assert not station.has_existing_time_intervals

    def test_remove_files(self):
        """
        The remove files function removes all files of the station that have
        been downloaded.

        This test mocks the os.path.exists() function to always return True
        and the utils.safe_delete() function to assure it has been called
        when appropriate.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.deepcopy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.deepcopy(time_intervals))
        channels = [c1, c2]
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)

        logger = mock.MagicMock()

        with mock.patch("os.path.exists") as exists_mock:
            exists_mock.return_value = True

            with mock.patch("obspy.clients.fdsn.mass_downloader"
                            ".utils.safe_delete") as p:
                # All status are NONE thus nothing should be deleted.
                station.remove_files(logger, reason="testing")
                assert p.call_count == 0
                assert exists_mock.call_count == 0

                # Set a random filename.
                filename = "/tmp/random.xml"
                station.stationxml_filename = filename
                # The setter of the stationxml_filename attribute should
                # check if the directory of the file already exists.
                assert exists_mock.call_count == 1
                exists_mock.reset_mock()

                # Set the status of the file to DOWNLOADED. It should now be
                # downloaded.
                station.stationxml_status = STATUS.DOWNLOADED
                station.remove_files(logger, reason="testing")
                assert p.call_count == 1
                assert p.call_args[0][0] == filename
                assert exists_mock.call_args[0][0] == filename
                exists_mock.reset_mock()
                p.reset_mock()

                # Now do the same with one of the time intervals.
                filename = "/tmp/random.mseed"
                station.stationxml_status = STATUS.NONE
                c1.intervals[0].filename = filename
                c1.intervals[0].status = STATUS.DOWNLOADED
                station.remove_files(logger, reason="testing")
                assert exists_mock.call_count == 1
                assert p.call_count == 1
                assert p.call_args[0][0] == filename
                assert exists_mock.call_args[0][0] == filename

    def test_temporal_bounds(self):
        """
        Tests the temporal bounds property.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.deepcopy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.deepcopy(time_intervals))
        channels = [c1, c2]
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)

        assert station.temporal_bounds == (st, st + 10 * 60)

    def test_sanitize_downloads(self):
        """
        Tests the sanitize_downloads() methods.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.deepcopy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.deepcopy(time_intervals))
        channels = [c1, c2]
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)

        logger = mock.MagicMock()

        with mock.patch("obspy.clients.fdsn.mass_downloader"
                        ".utils.safe_delete") as p1, \
                mock.patch("obspy.io.mseed.util.get_start_and_end_time") \
                as p2, \
                mock.patch("os.path.isfile") as p_isfile:  # NOQA
            p2.return_value = (obspy.UTCDateTime(1), obspy.UTCDateTime(2))
            # By default, nothing will happen.
            station.sanitize_downloads(logger)
            assert p1.call_count == 0
            p1.reset_mock()

            # The whole purpose of the method is to make sure that each
            # MiniSEED files has a corresponding StationXML file. MiniSEED
            # files that do not fulfill this requirement will be deleted.
            # Fake it.
            filename = "tmp/file.mseed"
            c1.intervals[0].status = STATUS.DOWNLOADED
            c1.intervals[0].filename = filename
            c1.intervals[1].status = STATUS.DOWNLOADED
            c1.intervals[1].filename = filename

            # Right now no channel has been marked missing, thus nothing should
            # happen.
            station.sanitize_downloads(logger)
            assert p1.call_count == 0
            p1.reset_mock()

            # Mark one as missing and the corresponding information should
            # be deleted
            station.miss_station_information[("", "BHZ")] = (
                obspy.UTCDateTime(1), obspy.UTCDateTime(2))
            station.sanitize_downloads(logger)
            assert p1.call_count == 2
            # The status of the channel should be adjusted
            assert c1.intervals[0].status == STATUS.DOWNLOAD_REJECTED
            assert c1.intervals[1].status == STATUS.DOWNLOAD_REJECTED
            p1.reset_mock()

    def test_prepare_mseed_download(self):
        """
        Tests the prepare_mseed download method.
        """
        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 60, st + (_i + 1) * 60) for _i in range(10)]
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.deepcopy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.deepcopy(time_intervals))
        channels = [c1, c2]
        all_tis = []
        for chan in channels:
            all_tis.extend(chan.intervals)
        station = Station(network="TA", station="A001", latitude=1,
                          longitude=2, channels=channels)

        # Patch the os.makedirs() function as it might be called at various
        # times.
        with mock.patch("os.makedirs") as p:
            # Now the output strongly depends on the `mseed_storage` keyword
            # argument. If it always returns True, all channels should be
            # ignored.
            station.prepare_mseed_download(
                mseed_storage=lambda *args, **kwargs: True)
            assert p.call_count == 0
            for i in all_tis:
                assert i.status == STATUS.IGNORE
            p.reset_mock()

            # Now if we just pass a string, it will be interpreted as a
            # foldername. It will naturally not exist, so all time intervals
            # will be marked as needing a download.
            with mock.patch("os.path.exists") as p_ex:
                p_ex.return_value = False
                station.prepare_mseed_download(
                    mseed_storage="/some/super/random/FJSD34J0J/path")
            # There are 20 time intervals.
            assert p.call_count == 20
            # Once for each file, once for each folder.
            assert p_ex.call_count == 40
            p.reset_mock()
            for i in all_tis:
                assert i.status == STATUS.NEEDS_DOWNLOADING

            # Last but not least, if the files already exist, they will be
            # marked as that.
            with mock.patch("os.path.exists") as p_ex:
                p_ex.return_value = True
                station.prepare_mseed_download(
                    mseed_storage="/some/super/random/FJSD34J0J/path")
            # No folder should be created.
            assert p.call_count == 0
            # Once for each file.
            assert p_ex.call_count == 20
            p.reset_mock()
            for i in all_tis:
                assert i.status == STATUS.EXISTS

    def test_prepare_stationxml_download_simple_cases(self):
        """
        Tests the simple cases of the prepare_stationxml_download() method.
        This method is crucial for everything to work thus it is tested
        rather extensively.
        """
        logger = mock.MagicMock()

        def _create_station():
            st = obspy.UTCDateTime(2015, 1, 1)
            time_intervals = [
                TimeInterval(st + _i * 60, st + (_i + 1) * 60)
                for _i in range(10)]
            c1 = Channel(location="", channel="BHZ",
                         intervals=copy.deepcopy(time_intervals))
            c2 = Channel(location="00", channel="EHE",
                         intervals=copy.deepcopy(time_intervals))
            channels = [c1, c2]
            all_tis = []
            for chan in channels:
                all_tis.extend(chan.intervals)
            station = Station(network="TA", station="A001", latitude=1,
                              longitude=2, channels=channels)
            return station

        temporal_bounds = (obspy.UTCDateTime(2015, 1, 1),
                           obspy.UTCDateTime(2015, 1, 1, 0, 10))

        # Again mock the os.makedirs function as it is called quite a bit.
        with mock.patch("os.makedirs") as p:

            # No time interval has any data, thus no interval actually needs
            # a station file. An interval only needs a station file if it
            # either downloaded data or if the data already exists.
            station = _create_station()
            station.prepare_stationxml_download(stationxml_storage="random",
                                                logger=logger)
            assert p.call_count == 0
            assert station.stationxml_status == STATUS.NONE
            assert station.want_station_information == {}
            assert station.miss_station_information == {}
            assert station.have_station_information == {}
            p.reset_mock()

            # Now the get_stationxml_filename() function will return a
            # string and the filename does not yet exist. All time
            # intervals require station information.
            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            with mock.patch("os.path.exists") as exists_p:
                exists_p.return_value = False
                station.prepare_stationxml_download(
                    stationxml_storage="random", logger=logger)
            assert p.call_count == 1
            # Called twice, once for the directory, once for the file. Both
            # return False as enforced with the mock.
            assert exists_p.call_count == 2
            assert exists_p.call_args_list[0][0][0] == "random"
            assert exists_p.call_args_list[1][0][0] == \
                os.path.join("random", "TA.A001.xml")
            # Thus it should attempt to download everything
            assert station.stationxml_filename == \
                os.path.join("random", "TA.A001.xml")
            assert station.stationxml_status == STATUS.NEEDS_DOWNLOADING
            assert station.have_station_information == {}
            assert station.want_station_information == \
                station.miss_station_information
            assert station.want_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

            # Now it returns a filename, the filename exists, and it
            # contains all necessary information.
            ChannelAvailability = collections.namedtuple(
                "ChannelAvailability",
                ["network", "station", "location", "channel", "starttime",
                 "endtime", "filename"])
            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            with mock.patch("os.path.exists") as exists_p:
                exists_p.return_value = True
                with mock.patch("obspy.clients.fdsn.mass_downloader.utils."
                                "get_stationxml_contents") as c_patch:
                    c_patch.return_value = [
                        ChannelAvailability("TA", "A001", "", "BHZ",
                                            obspy.UTCDateTime(2013, 1, 1),
                                            obspy.UTCDateTime(2016, 1, 1), ""),
                        ChannelAvailability("TA", "A001", "00", "EHE",
                                            obspy.UTCDateTime(2013, 1, 1),
                                            obspy.UTCDateTime(2016, 1, 1), "")]
                    station.prepare_stationxml_download(
                        stationxml_storage="random", logger=logger)
                    assert p.call_count == 0
            # It then should not attempt to download anything as everything
            # that's needed is already available.
            assert station.stationxml_status == STATUS.EXISTS
            assert station.miss_station_information == {}
            assert station.want_station_information == \
                station.have_station_information
            assert station.want_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

            # The last option for the simple case is that the file exists,
            # but it only contains part of the required information. In that
            # case everything will be downloaded again.
            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            with mock.patch("os.path.exists") as exists_p:
                exists_p.return_value = True
                with mock.patch("obspy.clients.fdsn.mass_downloader.utils."
                                "get_stationxml_contents") as c_patch:
                    c_patch.return_value = [
                        ChannelAvailability("TA", "A001", "", "BHZ",
                                            obspy.UTCDateTime(2013, 1, 1),
                                            obspy.UTCDateTime(2016, 1, 1), "")]
                    station.prepare_stationxml_download(
                        stationxml_storage="random", logger=logger)
                    assert p.call_count == 0
            # It then should not attempt to download anything as everything
            # that's needed is already available.
            assert station.stationxml_status == STATUS.NEEDS_DOWNLOADING
            assert station.have_station_information == {}
            assert station.want_station_information == \
                station.miss_station_information
            assert station.want_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

            # Now a combination that barely lacks the required time range.
            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            with mock.patch("os.path.exists") as exists_p:
                exists_p.return_value = True
                with mock.patch("obspy.clients.fdsn.mass_downloader.utils."
                                "get_stationxml_contents") as c_patch:
                    c_patch.return_value = [
                        ChannelAvailability(
                            "TA", "A001", "", "BHZ",
                            obspy.UTCDateTime(2015, 1, 1),
                            obspy.UTCDateTime(2015, 1, 1, 0, 9), ""),
                        ChannelAvailability("TA", "A001", "00", "EHE",
                                            obspy.UTCDateTime(2013, 1, 1),
                                            obspy.UTCDateTime(2016, 1, 1), "")]
                    station.prepare_stationxml_download(
                        stationxml_storage="random", logger=logger)
                    assert p.call_count == 0
            # It then should not attempt to download anything as everything
            # that's needed is already available.
            assert STATUS.NEEDS_DOWNLOADING == station.stationxml_status
            assert {} == station.have_station_information
            assert station.want_station_information == \
                station.miss_station_information
            assert station.want_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

    def test_prepare_stationxml_download_dictionary_case(self):
        """
        Tests the case of the prepare_stationxml_download() method if the
        get_stationxml_contents() method returns a dictionary.
        """
        logger = mock.MagicMock()
        temporal_bounds = (obspy.UTCDateTime(2015, 1, 1),
                           obspy.UTCDateTime(2015, 1, 1, 0, 10))

        def _create_station():
            st = obspy.UTCDateTime(2015, 1, 1)
            time_intervals = [
                TimeInterval(st + _i * 60, st + (_i + 1) * 60)
                for _i in range(10)]
            c1 = Channel(location="", channel="BHZ",
                         intervals=copy.deepcopy(time_intervals))
            c2 = Channel(location="00", channel="EHE",
                         intervals=copy.deepcopy(time_intervals))
            channels = [c1, c2]
            all_tis = []
            for chan in channels:
                all_tis.extend(chan.intervals)
            station = Station(network="TA", station="A001", latitude=1,
                              longitude=2, channels=channels)
            return station
        # Again mock the os.makedirs function as it is called quite a bit.
        with mock.patch("os.makedirs") as p:

            # Case 1: All channels are missing and thus must be downloaded.
            def stationxml_storage(network, station, channels, starttime,
                                   endtime):
                return {
                    "missing_channels": channels[:],
                    "available_channels": [],
                    "filename": os.path.join("random", "TA.AA01_.xml")
                }

            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            station.prepare_stationxml_download(
                stationxml_storage=stationxml_storage, logger=logger)
            # The directory should have been created if it does not exists.
            assert p.call_count == 1
            assert p.call_args[0][0] == "random"
            assert station.stationxml_status == STATUS.NEEDS_DOWNLOADING
            assert station.have_station_information == {}
            assert station.want_station_information == \
                station.miss_station_information
            assert station.want_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

            # Case 2: All channels are existing and thus nothing happens.
            def stationxml_storage(network, station, channels, starttime,
                                   endtime):
                return {
                    "missing_channels": [],
                    "available_channels": channels[:],
                    "filename": os.path.join("random", "TA.AA01_.xml")
                }

            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            station.prepare_stationxml_download(
                stationxml_storage=stationxml_storage, logger=logger)
            # The directory should have been created if it does not exists.
            assert p.call_count == 1
            assert p.call_args[0][0] == "random"
            assert station.stationxml_status == STATUS.EXISTS
            assert station.miss_station_information == {}
            assert station.want_station_information == \
                station.have_station_information
            assert station.have_station_information == {
                ("", "BHZ"): temporal_bounds,
                ("00", "EHE"): temporal_bounds
            }
            p.reset_mock()

            # Case 3: Mixed case.
            def stationxml_storage(network, station, channels, starttime,
                                   endtime):
                return {
                    "missing_channels":
                        [_i for _i in channels if _i[0] == "00"],
                    "available_channels":
                        [_i for _i in channels if _i[0] == ""],
                    "filename": os.path.join("random", "TA.AA01_.xml")
                }

            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            station.prepare_stationxml_download(
                stationxml_storage=stationxml_storage, logger=logger)
            # The directory should have been created if it does not exist.
            assert p.call_count == 1
            assert p.call_args[0][0] == "random"
            assert station.stationxml_status == STATUS.NEEDS_DOWNLOADING
            assert station.miss_station_information == {
                ("00", "EHE"): temporal_bounds
            }
            assert station.have_station_information == {
                ("", "BHZ"): temporal_bounds
            }
            assert station.want_station_information == {
                ("00", "EHE"): temporal_bounds,
                ("", "BHZ"): temporal_bounds
            }
            p.reset_mock()

            # Case 4: The stationxml_storage() function does not return all
            # required information. A warning should thus be raised.
            logger.reset_mock()

            def stationxml_storage(network, station, channels, starttime,
                                   endtime):
                return {
                    "missing_channels":
                        [_i for _i in channels if _i[0] == "00"],
                    "available_channels": [],
                    "filename": os.path.join("random", "TA.AA01_.xml")
                }

            station = _create_station()
            for cha in station.channels:
                for ti in cha.intervals:
                    ti.status = STATUS.DOWNLOADED
            station.prepare_stationxml_download(
                stationxml_storage=stationxml_storage, logger=logger)
            # The directory should have been created if it does not exist.
            assert p.call_count == 1
            assert p.call_args[0][0] == "random"
            assert station.stationxml_status == STATUS.NEEDS_DOWNLOADING
            assert station.miss_station_information == {
                ("00", "EHE"): temporal_bounds
            }
            assert station.have_station_information == {}
            assert station.want_station_information == {
                ("00", "EHE"): temporal_bounds,
                ("", "BHZ"): temporal_bounds
            }
            assert logger.method_calls[0][0] == "warning"
            assert "did not return information about channels" in \
                logger.method_calls[0][1][0]
            assert "BHZ" in \
                logger.method_calls[0][1][0]

    def test_str_method(self):
        """
        Test the __str__ method of the Station object.
        """
        # Minimal information.
        st = Station("BW", "ALTM", 10, 20, [])
        assert str(st) == (
            "Station 'BW.ALTM' [Lat: 10.00, Lng: 20.00]\n"
            "\t-> Filename: None (does not yet exist)\n"
            "\t-> Wants station information for channels:  \n"
            "\t-> Has station information for channels:    \n"
            "\t-> Misses station information for channels: \n\t")

        # A bit more information.
        channels = [Channel("", "BHE", [TimeInterval(obspy.UTCDateTime(0),
                                                     obspy.UTCDateTime(10))]),
                    Channel("", "BHZ", [TimeInterval(obspy.UTCDateTime(10),
                                                     obspy.UTCDateTime(20))])]
        st = Station("BW", "ALTM", 10, 20, channels=channels,
                     stationxml_status=STATUS.ignore)
        assert str(st) == (
            "Station 'BW.ALTM' [Lat: 10.00, Lng: 20.00]\n"
            "\t-> Filename: None (does not yet exist)\n"
            "\t-> Wants station information for channels:  \n"
            "\t-> Has station information for channels:    \n"
            "\t-> Misses station information for channels: \n"
            "\tChannel '.BHE':\n"
            "\t\tTimeInterval(start=UTCDateTime(1970, 1, 1, 0, 0), "
            "end=UTCDateTime(1970, 1, 1, 0, 0, 10), filename=None, "
            "status='none')\n"
            "\tChannel '.BHZ':\n"
            "\t\tTimeInterval(start=UTCDateTime(1970, 1, 1, 0, 0, 10), "
            "end=UTCDateTime(1970, 1, 1, 0, 0, 20), filename=None, "
            "status='none')")


class TestClientDownloadHelper():
    """
    Test cases for the ClientDownloadHelper class.
    """
    @pytest.fixture(autouse=True, scope="function")
    def setup(self):
        self.client = mock.MagicMock()
        self.client.base_url = "http://example.com"
        self.client_name = "Test"
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1))
        self.domain = domain.GlobalDomain()
        self.mseed_storage = "miniseed"
        self.stationxml_storage = "stationxml_storage"
        self.logger = mock.MagicMock()

    def _init_client(self):
        return ClientDownloadHelper(
            client=self.client, client_name=self.client_name,
            restrictions=self.restrictions, domain=self.domain,
            mseed_storage=self.mseed_storage,
            stationxml_storage=self.stationxml_storage, logger=self.logger)

    def test_looped_methods(self):
        """
        Some methods are just used to loop over methods on the station
        objects. Those are mocked here.
        """
        sta1 = mock.MagicMock()
        sta2 = mock.MagicMock()

        c = self._init_client()
        c.stations["BW.ALTM"] = sta1
        c.stations["BW.RJOB"] = sta2

        c.prepare_mseed_download()
        assert sta1.prepare_mseed_download.call_count == 1
        assert sta2.prepare_mseed_download.call_count == 1
        assert sta1.prepare_mseed_download.call_args[1]["mseed_storage"] == \
            self.mseed_storage
        assert sta2.prepare_mseed_download.call_args[1]["mseed_storage"] == \
            self.mseed_storage

        sta1.reset_mock()
        sta2.reset_mock()

        c.prepare_stationxml_download()
        assert sta1.prepare_stationxml_download.call_count == 1
        assert sta2.prepare_stationxml_download.call_count == 1

        sta1.reset_mock()
        sta2.reset_mock()

        c.sanitize_downloads()
        assert sta1.sanitize_downloads.call_count == 1
        assert sta2.sanitize_downloads.call_count == 1

    def test_basic_object_methods(self):
        """
        Tests some of the basic object methods.
        """
        c = self._init_client()

        assert not bool(c)
        assert len(c) == 0

        # Only the one at depth 200 should be removed as it is the only one
        # that has two neighbours inside the filter radius.
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 0, []),
            ("B", "B"): Station("B", "B", 0, 200, []),
            ("C", "C"): Station("C", "C", 0, 400, []),
            ("D", "D"): Station("D", "D", 0, 2000, [])
        }

        assert len(c) == 4
        assert bool(c)

        assert str(c).startswith(
            "ClientDownloadHelper object for client 'Test' "
            "(http://example.com)\n"
            "-> Unknown reliability of availability information\n"
            "-> Manages 4 stations.\n"
            "Station "
        )

    def test_station_list_nearest_neighbour_filter(self):
        """
        Test the filtering based on geographical distance.
        """
        self.restrictions = Restrictions(
            0, 1, minimum_interstation_distance_in_m=250)

        def _m_to_deg(meters):
            return meters / 111000.0

        c = self._init_client()

        # Only the one at longitude 200 should be removed as it is the only one
        # that has two neighbours inside the filter radius.
        c.stations = {
            ("A", "A"): Station("A", "A", 0, _m_to_deg(0), []),
            ("B", "B"): Station("B", "B", 0, _m_to_deg(200), []),
            ("C", "C"): Station("C", "C", 0, _m_to_deg(400), []),
            ("D", "D"): Station("D", "D", 0, _m_to_deg(2000), [])
        }
        # It should always filter out the one with 200 m longitude as if
        # that one is picked "A" and "C" can both be no longer picked.
        rej = c.filter_stations_based_on_minimum_distance([])
        assert [("A", "A"), ("C", "C"), ("D", "D")] == \
            sorted(c.stations.keys())
        assert [("B", "B")] == sorted(rej.keys())

        # The two at 200 and 250 m longitude should be removed.
        c.stations = {
            ("A", "A"): Station("A", "A", 0, _m_to_deg(0), []),
            ("B", "B"): Station("B", "B", 0, _m_to_deg(200), []),
            ("C", "C"): Station("C", "C", 0, _m_to_deg(250), []),
            ("D", "D"): Station("D", "D", 0, _m_to_deg(400), []),
            ("E", "E"): Station("E", "E", 0, _m_to_deg(2000), [])}
        rej = c.filter_stations_based_on_minimum_distance([])
        assert [("A", "A"), ("D", "D"), ("E", "E")] == \
            sorted(c.stations.keys())
        assert [("B", "B"), ("C", "C")] == sorted(rej.keys())

        # Set the distance to 1 degree and check the longitude behaviour at
        # the longitude wraparound point.
        stations = {
            ("A", "A"): Station("A", "A", 0, 0, []),
            ("B", "B"): Station("B", "B", 0, 90, []),
            ("C", "C"): Station("C", "C", 0, 180, []),
            ("D", "D"): Station("D", "D", 0, -90, []),
            ("E", "E"): Station("E", "E", 0, -180, [])}

        self.restrictions = Restrictions(
            0, 1, minimum_interstation_distance_in_m=111000)
        c = self._init_client()
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])

        # Only 4 stations should remain and either the one at 0,180 or the
        # one at 0, -180 should have been removed as they are equal.
        assert len(c.stations) == 4
        assert sorted(c.stations.keys()) == \
            [("A", "A"), ("B", "B"), ("C", "C"), ("D", "D")] or \
            sorted(c.stations.keys()) == \
            [("A", "A"), ("B", "B"), ("D", "D"), ("E", "E")]
        assert len(rej) == 1

        # Test filtering around the longitude wraparound.
        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, 179.2, []),
            ("C", "C"): Station("C", "C", 0, 180.8, [])}
        # The middle one should be removed as then the other two can be kept.
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert [("B", "B"), ("C", "C")] == sorted(c.stations.keys())
        assert [("A", "A")] == sorted(rej.keys())
        # Same but longitude defined the other way around.
        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, 179.2, []),
            ("C", "C"): Station("C", "C", 0, -179.2, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert [("B", "B"), ("C", "C")] == sorted(c.stations.keys())
        assert [("A", "A")] == sorted(rej.keys())

        # Test the conversion of lat/lng to meter distances.
        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, -180, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, -179.5, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, -179.1, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, 180, []),
            ("B", "B"): Station("B", "B", 0, 178.9, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 2
        assert len(rej) == 0

        # Also test the latitude settings.
        stations = {
            ("A", "A"): Station("A", "A", 0, -90, []),
            ("B", "B"): Station("B", "B", 0, -90, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, -90, []),
            ("B", "B"): Station("B", "B", 0, -89.5, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, -90, []),
            ("B", "B"): Station("B", "B", 0, -89.1, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 1
        assert len(rej) == 1

        stations = {
            ("A", "A"): Station("A", "A", 0, -90, []),
            ("B", "B"): Station("B", "B", 0, -88.9, [])}
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 2
        assert len(rej) == 0

        # Does not do anything if the minimum distance is not set.
        stations = {
            ("A", "A"): Station("A", "A", 0, 0, []),
            ("B", "B"): Station("B", "B", 0, 90, []),
            ("C", "C"): Station("C", "C", 0, 180, []),
            ("D", "D"): Station("D", "D", 0, -90, []),
            ("E", "E"): Station("E", "E", 0, -180, [])}

        self.restrictions = Restrictions(
            0, 1, minimum_interstation_distance_in_m=0)
        c = self._init_client()
        c.stations = stations
        rej = c.filter_stations_based_on_minimum_distance([])
        assert len(c.stations) == 5
        assert len(rej) == 0

        # Test with already existing stations. In that case the remaining
        # stations will be added to the existing one.
        self.restrictions = Restrictions(
            0, 1, minimum_interstation_distance_in_m=200)

        def _m_to_deg(meters):
            return meters / 111000.0

        # Two existing clients, both with one station.
        existing_client_a = self._init_client()
        existing_client_a.stations = {
            ("D", "D"): Station("D", "D", 0, _m_to_deg(2000), [])}

        existing_client_b = self._init_client()
        existing_client_b.stations = {
            ("A", "A"): Station("A", "A", 0, _m_to_deg(0), [])}

        ex_clients = [existing_client_a, existing_client_b]

        # New client has four stations.
        c = self._init_client()
        c.stations = {
            ("X", "X"): Station("X", "X", 0, _m_to_deg(100), []),
            ("B", "B"): Station("B", "B", 0, _m_to_deg(400), []),
            ("C", "C"): Station("C", "C", 0, _m_to_deg(500), []),
            ("Y", "Y"): Station("Y", "Y", 0, _m_to_deg(1900), [])}

        # Now it should only add station C as it has the furthest distance
        # to the existing stations.
        rej = c.filter_stations_based_on_minimum_distance(
            existing_client_dl_helpers=ex_clients)
        assert [("C", "C")] == sorted(c.stations.keys())
        assert [("B", "B"), ("X", "X"), ("Y", "Y")] == sorted(rej.keys())

    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "utils.download_and_split_mseed_bulk")
    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "download_helpers.ClientDownloadHelper._check_downloaded_data")
    def test_download_mseed(self, patch_check_data, patch_download_mseed):
        """
        Test the helper object that downloads from a client.
        """
        patch_check_data.return_value = (20, 5)

        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 1800, st + (_i + 1) * 1800)
            for _i in range(10)]
        for _i in time_intervals:
            _i.status = STATUS.NEEDS_DOWNLOADING
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.copy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.copy(time_intervals))
        channels = [c1, c2]

        # Create a client with a number of stations and channels.
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels)),
            ("B", "B"): Station("B", "B", 0, 20, copy.deepcopy(channels)),
            ("C", "C"): Station("C", "C", 0, 30, copy.deepcopy(channels)),
            ("D", "D"): Station("D", "D", 0, 40, copy.deepcopy(channels)),
            ("E", "E"): Station("E", "E", 0, 40, copy.deepcopy(channels)),
            ("F", "F"): Station("F", "F", 0, 40, copy.deepcopy(channels))}

        c.download_mseed()

        # Check data should be called once, and download mseed at least once
        # with each chunk all in all.
        assert patch_check_data.call_count == 1
        assert patch_download_mseed.call_count >= 1

        # 6 stations with 2 channels with 10 time intervals each.
        bulk_count = sum([
            len(_i[0][2]) for _i in patch_download_mseed.call_args_list])
        assert bulk_count == 120

        # Exotic band codes to trigger some rarer code paths.
        patch_check_data.reset_mock()
        patch_download_mseed.reset_mock()

        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 1800, st + (_i + 1) * 1800)
            for _i in range(10)]
        # Only the first five will require downloading.
        for _i in time_intervals[:5]:
            _i.status = STATUS.NEEDS_DOWNLOADING
        c1 = Channel(location="", channel="XHZ",
                     intervals=copy.copy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.copy(time_intervals))
        channels = [c1, c2]

        # Create a client with a number of stations and channels.
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels)),
            ("B", "B"): Station("B", "B", 0, 20, copy.deepcopy(channels)),
            ("C", "C"): Station("C", "C", 0, 30, copy.deepcopy(channels)),
            ("D", "D"): Station("D", "D", 0, 40, copy.deepcopy(channels)),
            ("E", "E"): Station("E", "E", 0, 40, copy.deepcopy(channels)),
            ("F", "F"): Station("F", "F", 0, 40, copy.deepcopy(channels))}

        c.download_mseed()

        # Check data should be called once, and download mseed at least once
        # with each chunk all in all.
        assert patch_check_data.call_count == 1
        assert patch_download_mseed.call_count >= 1

        # 6 stations with 2 channels with 10 time intervals each. But only 5
        # intervals require downloading for each.
        bulk_count = sum([
            len(_i[0][2]) for _i in patch_download_mseed.call_args_list])
        assert bulk_count == 60

        # Nothing to do when no stations exist.
        patch_check_data.reset_mock()
        patch_download_mseed.reset_mock()
        c = self._init_client()
        c.download_mseed()
        assert patch_check_data.call_count == 0
        assert patch_download_mseed.call_count == 0

        # Last one to trigger a bit of exception handling.
        patch_check_data.reset_mock()
        patch_download_mseed.reset_mock()
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels))
        }

        patch_download_mseed.side_effect = socket_timeout("Nooooo")

        c.download_mseed()
        assert patch_check_data.call_count == 1
        assert patch_download_mseed.call_count == 1
        # The error logger should have been called once
        assert c.logger.error.call_count == 1

        patch_check_data.reset_mock()
        patch_download_mseed.reset_mock()
        c.logger.reset_mock()
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels))
        }

        patch_download_mseed.side_effect = socket_timeout("no data available")

        c.download_mseed()
        assert patch_check_data.call_count == 1
        assert patch_download_mseed.call_count == 1
        # The error logger should not have been called  as no data available
        # is just an info message.
        assert c.logger.error.call_count == 0

        patch_check_data.reset_mock()
        patch_download_mseed.reset_mock()
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels))
        }

        patch_download_mseed.side_effect = HTTPException("disconnected")

        c.download_mseed()
        assert patch_check_data.call_count == 1
        assert patch_download_mseed.call_count == 1
        # The error logger should have been called once
        assert c.logger.error.call_count == 1

    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "utils.download_stationxml")
    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "utils.get_stationxml_contents")
    @mock.patch("os.makedirs")
    @mock.patch("os.path.getsize")
    def test_download_stationxml(self, patch_getsize, patch_mkdir,
                                 patch_get_stationxml_contents,
                                 patch_download_stationxml):
        """
        Tests the helper objects that downloads station information from a
        client.

        This (like some others) is a bit of a silly test as it is largely
        mocked but at least it makes sure everything can be executed.
        """
        patch_getsize.return_value = 100

        ChannelAvailability = collections.namedtuple(
            "ChannelAvailability",
            ["network", "station", "location", "channel", "starttime",
             "endtime", "filename"])

        patch_get_stationxml_contents.return_value = [ChannelAvailability(
            "A", "A", "", "BHZ", obspy.UTCDateTime(0), obspy.UTCDateTime(1),
            "temp.xml")]

        st = obspy.UTCDateTime(2015, 1, 1)
        time_intervals = [
            TimeInterval(st + _i * 1800, st + (_i + 1) * 1800)
            for _i in range(10)]
        for _i in time_intervals:
            _i.status = STATUS.NEEDS_DOWNLOADING
        c1 = Channel(location="", channel="BHZ",
                     intervals=copy.copy(time_intervals))
        c2 = Channel(location="00", channel="EHE",
                     intervals=copy.copy(time_intervals))
        channels = [c1, c2]

        # Create a client with a number of stations and channels.
        c = self._init_client()
        c.stations = {
            ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels)),
            ("B", "B"): Station("B", "B", 0, 20, copy.deepcopy(channels)),
            ("C", "C"): Station("C", "C", 0, 30, copy.deepcopy(channels)),
            ("D", "D"): Station("D", "D", 0, 40, copy.deepcopy(channels)),
            ("E", "E"): Station("E", "E", 0, 40, copy.deepcopy(channels)),
            ("F", "F"): Station("F", "F", 0, 40, copy.deepcopy(channels))}

        def ret_val(*args, **kwargs):
            return (args[2][0][0], args[2][0][1]), args[-1]

        patch_download_stationxml.side_effect = ret_val

        missing_info = {}
        for channel in channels:
            missing_info[(channel.location, channel.channel)] = \
                channel.intervals

        for station in c.stations.values():
            station.miss_station_information = copy.deepcopy(missing_info)
            station.stationxml_filename = "temp.xml"

        c.download_stationxml()

    def test_get_availability(self, testdata):
        """
        Tests the get_availability function.
        """
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()

    def test_get_availability_with_multiple_channel_epochs(self, testdata):
        """
        Make sure to get rid of du
        """
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn_with_multiple_epochs.txt"])
        c.get_availability()
        assert list(c.stations.keys()) == [("TA", "857A")]
        assert len(c.stations[("TA", "857A")].channels) == 1
        chan = c.stations[("TA", "857A")].channels[0]
        assert chan.intervals[0].start == c.restrictions.starttime
        assert chan.intervals[0].end == c.restrictions.endtime

    def test_excluding_networks_and_stations(self, testdata):
        """
        Tests the excluding of networks and stations.
        """
        restrictions_list = [
            # Default
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1)),
            # Excluding things that don't exists does not do anything.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_networks=["Z*", "ZNB", "[XYZ]?"],
                exclude_stations=["A*", "[CD]?", "ZNF"]),
            # Simple network exclude.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_networks=["AK"]),
            # Wildcarded network exclude.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_networks=["?K"]),
            # Multiple network excludes
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_networks=["AK", "AZ"]),
            # Simple station exclude.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_stations=["BAGL"]),
            # Wildcarded station exclude.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_stations=["[AB]?N"]),
            # Multiple excludes.
            Restrictions(
                starttime=obspy.UTCDateTime(2001, 1, 1),
                endtime=obspy.UTCDateTime(2015, 1, 1),
                station_starttime=obspy.UTCDateTime(2000, 1, 1),
                station_endtime=obspy.UTCDateTime(2015, 1, 1),
                exclude_stations=["BWN", "BZN"]),
            ]
        results_list = [
            [("AK", "BAGL"), ("AK", "BWN"), ("AZ", "BZN")],
            [("AK", "BAGL"), ("AK", "BWN"), ("AZ", "BZN")],
            [("AZ", "BZN")],
            [("AZ", "BZN")],
            [],
            [("AK", "BWN"), ("AZ", "BZN")],
            [("AK", "BAGL")],
            [("AK", "BAGL")],
            ]
        for restrictions, expected in zip(restrictions_list, results_list):
            self.restrictions = restrictions
            c = self._init_client()
            c.client.get_stations.return_value = \
                obspy.read_inventory(testdata["channel_level_fdsn.txt"])
            c.get_availability()
            assert sorted(c.stations.keys()) == expected

        # When 'channel' or 'location' are set they should override
        # 'channel_priorities' and 'location_priorities'. If this isn't
        # happening this test will fail, as we're requesting data
        # with a channel and location what are not covered by the default
        # priorities lists.
        #
        # The tests are a bit strange in the way that the availability
        # filtering does not enforce the set "location" + "channel" but only
        # the priority lists. Location + channel are already set at the queries
        # to the datacenters so they can be assumed to be correct.
        #
        # The availability information contains uncommon channel + location
        # combinations and only one station will be selected first.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            # This will be ignored as soon as channel and location are being
            # set.
            channel_priorities=["EH*", "BH*"],
            location_priorities=["", "01"])
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["uncommon_channel_location.txt"])
        c.get_availability()
        assert [("AK", "BAGLD")] == sorted(c.stations.keys())

        # With a set location, the channel priorities are still active.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            channel_priorities=["EH*", "BH*"],
            location_priorities=["", "01"],
            location="31")
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["uncommon_channel_location.txt"])
        c.get_availability()
        assert [("AK", "BAGLC"), ("AK", "BAGLD")] == sorted(c.stations.keys())

        # Same with the set channel.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            channel_priorities=["EH*", "BH*"],
            location_priorities=["", "01"],
            channel="RST")
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["uncommon_channel_location.txt"])
        c.get_availability()
        assert [("AK", "BAGLB"), ("AK", "BAGLD")] == sorted(c.stations.keys())

        # If both are set, the priorities are properly ignored.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            channel_priorities=["EH*", "BH*"],
            location_priorities=["", "01"],
            location="31",
            channel="RST")
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["uncommon_channel_location.txt"])
        c.get_availability()
        assert [("AK", "BAGLA"), ("AK", "BAGLB"), ("AK", "BAGLC"),
                ("AK", "BAGLD")] == sorted(c.stations.keys())

    def test_excluding_networks_and_stations_with_an_inventory_object(
            self, testdata):
        """
        Tests the excluding of networks and stations with the help of an
        inventory object.
        """
        full_inv = obspy.read_inventory(testdata["channel_level_fdsn.txt"])

        # Default
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [("AK", "BAGL"), ("AK", "BWN"), ("AZ", "BZN")] == \
            sorted(c.stations.keys())

        # Keep everything.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1),
            limit_stations_to_inventory=full_inv
        )
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [("AK", "BAGL"), ("AK", "BWN"), ("AZ", "BZN")] == \
            sorted(c.stations.keys())

        # Exclude one station.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1),
            # Keep all AK stations.
            limit_stations_to_inventory=full_inv.select(network="AK")
        )
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [("AK", "BAGL"), ("AK", "BWN")] == sorted(c.stations.keys())

        # Keep only one station.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1),
            # Keep only the AZ station.
            limit_stations_to_inventory=full_inv.select(network="AZ")
        )
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [("AZ", "BZN")] == sorted(c.stations.keys())

        # Keep only one station.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1),
            limit_stations_to_inventory=full_inv.select(station="BZN")
        )
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [("AZ", "BZN")] == sorted(c.stations.keys())

        # Keep nothing.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            station_starttime=obspy.UTCDateTime(2000, 1, 1),
            station_endtime=obspy.UTCDateTime(2015, 1, 1),
            limit_stations_to_inventory=obspy.Inventory(networks=[], source="")
        )
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn.txt"])
        c.get_availability()
        assert [] == sorted(c.stations.keys())

    def test_parse_miniseed_filenames(self):
        """
        Tests the MiniSEED filename parsing of the helper objects.
        """
        c = self._init_client()

        with NamedTemporaryFile() as tf:
            tf.close()
            filename = tf.name
            tr = obspy.read()[0]
            tr.write(filename, format="mseed")
            result = c._parse_miniseed_filenames([filename], self.restrictions)
            assert result == []

            # No minimum length restrictions. Now it should pass.
            self.restrictions.minimum_length = 0
            tr.write(filename, format="mseed")
            result = c._parse_miniseed_filenames([filename], self.restrictions)
            assert len(result) == 1
            assert result[0].network == "BW"
            assert result[0].station == "RJOB"
            assert result[0].location == ""
            assert result[0].channel == "EHZ"
            assert result[0].starttime == \
                obspy.UTCDateTime(2009, 8, 24, 0, 20, 3)
            assert result[0].endtime == \
                obspy.UTCDateTime(2009, 8, 24, 0, 20, 32, 990000)
            assert result[0].filename == filename

            # Add a gap.
            self.restrictions.minimum_length = 0
            st = obspy.read()
            st = st[0:1] + st[0:1]
            st[1].stats.starttime += 10
            st.write(filename, format="mseed")
            result = c._parse_miniseed_filenames([filename], self.restrictions)
            assert len(result) == 0

            # File no longer exists.
            assert os.path.exists(filename) is False

            # Write something to make sure the context manager works.
            with open(filename, "w") as buf:
                buf.write("obspy")

    def test_warning_when_location_prios_excludes_all_channels(self, testdata):
        """
        Tests that the logger raises a warning when the location_priorities
        settings excludes all channels.
        """
        # No warning should have been raised yet.
        assert self.logger.warning.call_count == 0
        c = self._init_client()
        c.client.get_stations.return_value = obspy.read_inventory(
            testdata["channel_level_fdsn_obscure_location_code.txt"])
        c.get_availability()
        # Nothing should have been selected.
        assert c.stations == {}
        # But a warning should have been raised.
        assert self.logger.warning.call_count == 1
        assert self.logger.warning.call_args[0][0] == (
            "Client 'Test' - No channel at station AK.BAGL has been selected "
            "due to the `location_priorities` settings.")

        self.logger.warning.reset_mock()
        assert self.logger.warning.call_count == 0
        # Having non-default location priorities should not warn.
        self.restrictions = Restrictions(
            starttime=obspy.UTCDateTime(2001, 1, 1),
            endtime=obspy.UTCDateTime(2015, 1, 1),
            location_priorities=["00"])
        assert c.stations == {}
        assert self.logger.warning.call_count == 0


class TestDownloadHelper():
    """
    Test cases for the MassDownloader class.
    """
    @mock.patch("obspy.clients.fdsn.mass_downloader.mass_downloader."
                "MassDownloader._initialize_clients")
    def test_initialization(self, patch):
        """
        Tests the initialization of the MassDownloader object.
        """
        d = MassDownloader()
        assert patch.call_count == 1
        # The amount of services is variable and more and more get added.
        # Assert it's larger then 8 and contains a couple stable ones.
        assert len(d.providers) > 8
        assert "IRIS" in d.providers
        assert "ORFEUS" in d.providers
        patch.reset_mock()

        d = MassDownloader(providers=["A", "B", "IRIS"])
        assert patch.call_count == 1
        assert d.providers == ("A", "B", "IRIS")
        patch.reset_mock()

    @mock.patch("obspy.clients.fdsn.client.Client._discover_services",
                autospec=True)
    @mock.patch("logging.Logger.info")
    @mock.patch("logging.Logger.warning")
    def test_initialization_detailed(self, log_w, log_p, patch):
        def side_effect(self, *args, **kwargs):
            if "iris" in self.base_url:
                self.services = {"dataselect": "dummy"}
            elif "gfz" in self.base_url:
                raise socket_timeout("Random Error")
            elif "resif" in self.base_url:
                raise socket_timeout("timeout error")
            else:
                self.services = {"dataselect": "dummy", "station": "dummy_2"}

        patch.side_effect = side_effect

        logger = logging.getLogger("obspy.clients.fdsn.mass_downloader")
        _l = logger.level
        logger.setLevel(logging.CRITICAL)

        try:
            d = MassDownloader()
        finally:
            # Make sure to not change the log-level.
            logger.setLevel(_l)

        assert len(d._initialized_clients) > 10
        assert not ("IRIS" in d._initialized_clients)
        assert not ("RESIF" in d._initialized_clients)
        assert not ("GFZ" in d._initialized_clients)
        assert "ORFEUS" in d._initialized_clients

    @mock.patch("obspy.clients.fdsn.client.Client._discover_services",
                autospec=True)
    @mock.patch("logging.Logger.info")
    @mock.patch("logging.Logger.warning")
    def test_initialization_with_existing_clients(self, log_w, log_p, patch):
        def side_effect(self, *args, **kwargs):
            self.services = {"dataselect": "dummy", "station": "dummy"}
        patch.side_effect = side_effect

        client = Client("IRIS", user="random", password="something")

        assert patch.call_count == 1
        patch.reset_mock()
        assert patch.call_count == 0

        # Make sure to not change the log-level but also to hide the log
        # output for the tests.
        logger = logging.getLogger("obspy.clients.fdsn.mass_downloader")
        _l = logger.level
        logger.setLevel(logging.CRITICAL)
        try:
            d = MassDownloader(providers=["GFZ", client, "ORFEUS"])
        finally:
            logger.setLevel(_l)

        # Should have been called twice.
        assert patch.call_count == 2

        assert list(d._initialized_clients.keys()) == \
            ['GFZ', 'http://service.iris.edu', 'ORFEUS']
        # Make sure it is the same object.
        assert d._initialized_clients["http://service.iris.edu"] is client

    @mock.patch("obspy.clients.fdsn.client.Client._discover_services",
                autospec=True)
    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "download_helpers.ClientDownloadHelper.get_availability",
                autospec=True)
    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "download_helpers.ClientDownloadHelper.download_mseed")
    @mock.patch("obspy.clients.fdsn.mass_downloader."
                "download_helpers.ClientDownloadHelper.download_stationxml")
    @mock.patch("os.makedirs")
    @mock.patch("logging.Logger.info")
    @mock.patch("logging.Logger.warning")
    def test_download_method(self, _log_w, _log_p, _patch_makedirs,
                             patch_dl_mseed, patch_dl_stationxml,
                             patch_get_avail, patch_discover):
        """
        Mock test of the central download method.

        This only assures that every line of code can be executed...the
        actual logic is very complex all in all and is tested by the
        sub-objects and methods and by simply using the download helpers.
        """
        def side_effect(self, *args, **kwargs):
            self.services = {"dataselect": "dummy", "station": "dummy_2"}
        patch_discover.side_effect = side_effect

        dom = domain.RectangularDomain(-10, 10, -20, 20)
        restrictions = Restrictions(
            starttime=obspy.UTCDateTime(0),
            endtime=obspy.UTCDateTime(10))

        # No availability for all.
        d = MassDownloader()
        d.download(domain=dom, restrictions=restrictions,
                   mseed_storage="mseed", stationxml_storage="stationxml")

        # Availability for all.
        d = MassDownloader()

        def avail(self):
            if self.client_name == "IRIS":
                self.is_availability_reliable = True
            else:
                self.is_availability_reliable = False

            st = obspy.UTCDateTime(2015, 1, 1)
            time_intervals = [
                TimeInterval(st + _i * 1800, st + (_i + 1) * 1800)
                for _i in range(10)]
            for _i in time_intervals:
                _i.status = STATUS.NEEDS_DOWNLOADING
            c1 = Channel(location="", channel="BHZ",
                         intervals=copy.copy(time_intervals))
            c2 = Channel(location="00", channel="EHE",
                         intervals=copy.copy(time_intervals))
            channels = [c1, c2]

            # Create a client with a number of stations and channels.
            self.stations = {
                ("A", "A"): Station("A", "A", 0, 10, copy.deepcopy(channels)),
                ("B", "B"): Station("B", "B", 0, 20, copy.deepcopy(channels)),
                ("C", "C"): Station("C", "C", 0, 30, copy.deepcopy(channels)),
                ("D", "D"): Station("D", "D", 0, 40, copy.deepcopy(channels)),
                ("E", "E"): Station("E", "E", 0, 40, copy.deepcopy(channels)),
                ("F", "F"): Station("F", "F", 0, 40, copy.deepcopy(channels))}

        patch_get_avail.side_effect = avail

        d.download(domain=dom, restrictions=restrictions,
                   mseed_storage="mseed", stationxml_storage="stationxml")

        # Discard all stations.
        with mock.patch("obspy.clients.fdsn.mass_downloader.download_helpers."
                        "ClientDownloadHelper.discard_stations",
                        autospec=True) as p:
            def temp(self, *args, **kwargs):
                self.stations = {}
            p.side_effect = temp

            d = MassDownloader()

            d.download(domain=dom, restrictions=restrictions,
                       mseed_storage="mseed", stationxml_storage="stationxml")

        # Filter all.
        # Discard all stations.
        with mock.patch("obspy.clients.fdsn.mass_downloader.download_helpers."
                        "ClientDownloadHelper"
                        ".filter_stations_based_on_minimum_distance",
                        autospec=True) as p:
            def temp(self, *args, **kwargs):
                self.stations = {}
            p.side_effect = temp

            d = MassDownloader()
            d.download(domain=dom, restrictions=restrictions,
                       mseed_storage="mseed", stationxml_storage="stationxml")