osf.io/osf_tests/metrics/test_daily_report.py at 92728649e888730b472ac9b1cddccc916d6a1b80 · CenterForOpenScience/osf.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
import datetime
from unittest import mock

import pytest
import elasticsearch_metrics.imps.elastic6 as metrics

from osf.metrics.reports import DailyReport, ReportInvalid


class TestDailyReportKey:
    @pytest.fixture
    def mock_save(self):
        with mock.patch('elasticsearch6_dsl.Document.save', autospec=True) as mock_save:
            yield mock_save

    def test_default(self, mock_save):
        # only one of this type of report per day
        class UniqueByDate(DailyReport):
            blah = metrics.Keyword()

            class Meta:
                app_label = 'osf'

        today = datetime.date(2022, 5, 18)
        expected_timestamp = datetime.datetime(
            today.year,
            today.month,
            today.day,
            tzinfo=datetime.UTC,
        )

        reports = [
            UniqueByDate(report_date=today),
            UniqueByDate(report_date=today, blah='blah'),
            UniqueByDate(report_date=today, blah='fleh'),
        ]
        expected_key = '6fe48593af0f9d34159616759bd4678f383c912fdff3e8a338c51ecb1cf9d0d5'

        for report in reports:
            report.save()
            assert mock_save.call_count == 1
            assert mock_save.call_args[0][0] is report
            assert report.meta.id == expected_key
            assert report.timestamp == expected_timestamp
            mock_save.reset_mock()

    def test_with_unique_together(self, mock_save):
        # multiple reports of this type per day, unique by given field
        class UniqueByDateAndField(DailyReport):
            UNIQUE_TOGETHER_FIELDS = ('report_date', 'uniquefield',)
            uniquefield = metrics.Keyword()

            class Meta:
                app_label = 'osf'

        today = datetime.date(2022, 5, 18)
        expected_timestamp = datetime.datetime(
            today.year,
            today.month,
            today.day,
            tzinfo=datetime.UTC,
        )

        expected_blah = 'dca57e6cde89b19274ea24bc713971dab137a896b8e06d43a11a3f437cd1d151'
        blah_report = UniqueByDateAndField(report_date=today, uniquefield='blah')
        blah_report.save()
        assert mock_save.call_count == 1
        assert mock_save.call_args[0][0] is blah_report
        assert blah_report.meta.id == expected_blah
        assert blah_report.timestamp == expected_timestamp
        mock_save.reset_mock()

        expected_fleh = 'e7dd5ff6b087807efcfa958077dc713878f21c65af79b3ccdb5dc2409bf5ad99'
        fleh_report = UniqueByDateAndField(report_date=today, uniquefield='fleh')
        fleh_report.save()
        assert mock_save.call_count == 1
        assert mock_save.call_args[0][0] is fleh_report
        assert fleh_report.meta.id == expected_fleh
        assert fleh_report.timestamp == expected_timestamp
        mock_save.reset_mock()

        for _bad_report in (
            UniqueByDateAndField(report_date=today),
            UniqueByDateAndField(report_date=today, uniquefield=['list', 'of', 'things']),
        ):
            with pytest.raises(ReportInvalid):
                _bad_report.save()