From 285db045952a4d7489c48c476137ade863a45b39 Mon Sep 17 00:00:00 2001 From: Blake Long Date: Fri, 22 Apr 2022 12:49:29 -0600 Subject: [PATCH 001/235] refactored gaitid and fundcode into a FK relationship with program table --- factories/workflow_models.py | 18 +++- .../fixtures/one_program_home_page.yaml | 8 +- indicators/fixtures/one_year_program.yaml | 8 +- .../commands/qa_program_widgets/qa_widgets.py | 10 +- indicators/views/view_utils.py | 2 +- indicators/views/views_program.py | 2 +- tola_management/programadmin.py | 8 +- .../tests/test_programadmin_viewset.py | 6 +- .../commands/migrate_gaitid_fundcode.py | 96 +++++++++++++++++++ .../migrations/0060_auto_20220420_1225.py | 48 ++++++++++ workflow/models.py | 60 +++++++----- .../program_page_program_serializers.py | 7 -- .../program_page_program_serializers.py | 11 --- workflow/tests/test_gaitid.py | 42 ++++++++ workflow/tests/test_model_validators.py | 45 +++++++++ workflow/validators.py | 12 +++ 16 files changed, 329 insertions(+), 54 deletions(-) create mode 100644 workflow/management/commands/migrate_gaitid_fundcode.py create mode 100644 workflow/migrations/0060_auto_20220420_1225.py create mode 100644 workflow/tests/test_gaitid.py create mode 100644 workflow/tests/test_model_validators.py create mode 100644 workflow/validators.py diff --git a/factories/workflow_models.py b/factories/workflow_models.py index 747ddc636..2a0243638 100644 --- a/factories/workflow_models.py +++ b/factories/workflow_models.py @@ -28,6 +28,7 @@ Program, CountryAccess, ProgramAccess, + GaitID, PROGRAM_ROLE_CHOICES, COUNTRY_ROLE_CHOICES ) @@ -123,10 +124,18 @@ def password(obj, create, extracted, **kwargs): obj.user.save() +class GaitIDFactory(DjangoModelFactory): + + class Meta: + model = GaitID + django_get_or_create = ('gaitid',) + + gaitid = Sequence(lambda n: "%0030d" % n) + + class ProgramFactory(DjangoModelFactory): class Meta: model = Program - django_get_or_create = ('gaitid',) class Params: active = True @@ -138,7 +147,7 @@ class Params: ) name = 'Health and Survival for Syrians in Affected Regions' - gaitid = Sequence(lambda n: "%0030d" % n) + gaitid = RelatedFactory(GaitIDFactory, factory_related_name='program') country = RelatedFactory(CountryFactory, country='United States', code='US') funding_status = LazyAttribute(lambda o: "funded" if o.active else "Inactive") _using_results_framework = Program.RF_ALWAYS @@ -177,11 +186,16 @@ class Params: age = False name = Faker('company') + gaitid = RelatedFactory(GaitIDFactory, factory_related_name='program') funding_status = LazyAttribute(lambda o: "Funded" if o.active else "Inactive") _using_results_framework = LazyAttribute( lambda o: Program.RF_ALWAYS if o.migrated is None else Program.MIGRATED if o.migrated else Program.NOT_MIGRATED ) + @post_generation + def gaitid(self, create, extracted, **kwargs): + GaitIDFactory(gaitid='123456', program=self) + @lazy_attribute def reporting_period_start(self): year = datetime.date.today().year diff --git a/indicators/fixtures/one_program_home_page.yaml b/indicators/fixtures/one_program_home_page.yaml index 2b59a8c60..a39b3bc61 100644 --- a/indicators/fixtures/one_program_home_page.yaml +++ b/indicators/fixtures/one_program_home_page.yaml @@ -10,7 +10,6 @@ - model: workflow.program pk: 1 fields: - gaitid: '1' name: Basic One Year Program funding_status: Funded cost_center: null @@ -23,6 +22,13 @@ reporting_period_end: 2016-12-31 sector: [] country: [1] +- model: workflow.gaitid + pk: 1 + fields: + gaitid: '1' + program: 1 + create_date: 2022-04-01 + edit_date: 2022-04-01 - model: indicators.indicator pk: 1 fields: diff --git a/indicators/fixtures/one_year_program.yaml b/indicators/fixtures/one_year_program.yaml index 5fa16dfd9..f06e665f2 100644 --- a/indicators/fixtures/one_year_program.yaml +++ b/indicators/fixtures/one_year_program.yaml @@ -10,7 +10,6 @@ - model: workflow.program pk: 1 fields: - gaitid: '1' name: Basic One Year Program funding_status: Funded cost_center: null @@ -23,3 +22,10 @@ reporting_period_end: 2017-12-31 sector: [] country: [1] +- model: workflow.gaitid + pk: 1 + fields: + gaitid: '1' + program: 1 + create_date: 2022-04-01 + edit_date: 2022-04-01 diff --git a/indicators/management/commands/qa_program_widgets/qa_widgets.py b/indicators/management/commands/qa_program_widgets/qa_widgets.py index b7dcebdfa..e852e6025 100644 --- a/indicators/management/commands/qa_program_widgets/qa_widgets.py +++ b/indicators/management/commands/qa_program_widgets/qa_widgets.py @@ -20,7 +20,7 @@ DisaggregatedValue, LevelTier, ) -from workflow.models import Program, Country, Organization, TolaUser, SiteProfile, Sector +from workflow.models import Program, Country, Organization, TolaUser, SiteProfile, Sector, GaitID from indicators.views.views_indicators import generate_periodic_targets @@ -35,6 +35,10 @@ def __init__(self, country): self.default_start_date = (date.today() + relativedelta(months=-18)).replace(day=1) self.default_end_date = (self.default_start_date + relativedelta(months=+32)).replace(day=1) - timedelta(days=1) + def create_gait_id(self, program_id): + gait_id = GaitID(gaitid=random.randint(1, 9999), program_id=program_id) + gait_id.save() + def create_program( self, name, start_date=False, end_date=False, post_satsuma=True, multi_country=False, create_levels=True): if not start_date: @@ -49,10 +53,12 @@ def create_program( 'reporting_period_start': start_date, 'reporting_period_end': end_date, 'funding_status': 'Funded', - 'gaitid': 'fake_gait_id_{}'.format(random.randint(1, 9999)), '_using_results_framework': Program.RF_ALWAYS if post_satsuma else Program.NOT_MIGRATED, }) program.country.add(self.country) + + self.create_gait_id(program.id) + if multi_country: country2 = Country.objects.get(country="United States") program.country.add(country2) diff --git a/indicators/views/view_utils.py b/indicators/views/view_utils.py index 7e96ae3b4..7a00f253f 100644 --- a/indicators/views/view_utils.py +++ b/indicators/views/view_utils.py @@ -154,7 +154,7 @@ def program_rollup_data(program, for_csv=False): dict = { "unique_id": program.pk, "program_name": program.name, - "gait_id": program.gaitid, + "gait_id": program.gaitids, "countries": " / ".join([c.country for c in program.country.all()]) if for_csv else [c.country for c in program.country.all()], "sectors": " / ".join(set([i.sector.sector for i in program.indicator_set.all() if i.sector and i.sector.sector])) if for_csv else set([i.sector.sector for i in program.indicator_set.all() if i.sector and i.sector.sector]), diff --git a/indicators/views/views_program.py b/indicators/views/views_program.py index a06f0f58e..1592ff79a 100644 --- a/indicators/views/views_program.py +++ b/indicators/views/views_program.py @@ -317,7 +317,7 @@ def get_parent_segment(ontology_segments, level): direction_of_change_map[indicator.direction_of_change] if indicator.direction_of_change else 'None', indicator.lop_target_calculated if indicator.lop_target_calculated else indicator.lop_target, program.name, - program.gaitid if program.gaitid else "no gait_id, program id {}".format(program.id), + program.gaitids if program.gaitids else "no gait_id, program id {}".format(program.id), '/'.join([c.strip() for c in program.countries.split(',')]), '/'.join(set(regions)), 'Active' if program.funding_status == 'Funded' else 'Inactive', diff --git a/tola_management/programadmin.py b/tola_management/programadmin.py index f5a030d2e..014dda557 100644 --- a/tola_management/programadmin.py +++ b/tola_management/programadmin.py @@ -19,7 +19,8 @@ ValidationError, BooleanField, DateTimeField, - SerializerMethodField + SerializerMethodField, + StringRelatedField ) from openpyxl import Workbook, utils @@ -241,7 +242,7 @@ class ProgramAdminSerializer(ModelSerializer): id = IntegerField(allow_null=True, required=False) name = CharField(required=True, max_length=255) funding_status = CharField(required=True) - gaitid = CharField(required=False, allow_blank=True, allow_null=True) + gaitid = StringRelatedField(many=True) fundCode = CharField(required=False, allow_blank=True, allow_null=True, source='cost_center') description = CharField(allow_null=True, allow_blank=True) sector = NestedSectorSerializer(required=True, many=True) @@ -497,7 +498,8 @@ def base_queryset(cls): ), ), to_attr='country_with_users' - ) + ), + 'gaitid' ) return queryset diff --git a/tola_management/tests/test_programadmin_viewset.py b/tola_management/tests/test_programadmin_viewset.py index d61d1a151..514ee20c3 100644 --- a/tola_management/tests/test_programadmin_viewset.py +++ b/tola_management/tests/test_programadmin_viewset.py @@ -40,7 +40,7 @@ def test_base_program_info(self): data = ProgramAdminSerializer(queryset, many=True).data[0] self.assertEqual(data['name'], SPECIAL_CHARS) self.assertEqual(data['funding_status'], 'funded') - self.assertEqual(data['gaitid'], '123456') + self.assertEqual(data['gaitid'][0], '123456') self.assertEqual(data['description'], 'A description') self.assertEqual(data['id'], program.pk) @@ -207,7 +207,7 @@ def get_program(self, program_pk): def get_data(self, program_qs): # 3 queries: program with annotations, prefetched sectors, prefetched countries - with self.assertNumQueries(6): + with self.assertNumQueries(7): return ProgramAdminSerializer(program_qs, many=True).data[0] def get_users_filtered_data(self, program_pk): @@ -276,7 +276,7 @@ def test_with_superusers_program(self): self.assertEqual(users_data['count'], 14) def test_query_count_on_multiple(self): - with self.assertNumQueries(7): + with self.assertNumQueries(8): program_qs = ProgramAdminViewSet.base_queryset().all() data = ProgramAdminSerializer(program_qs, many=True).data self.assertEqual(len(data), 25) diff --git a/workflow/management/commands/migrate_gaitid_fundcode.py b/workflow/management/commands/migrate_gaitid_fundcode.py new file mode 100644 index 000000000..5614e1788 --- /dev/null +++ b/workflow/management/commands/migrate_gaitid_fundcode.py @@ -0,0 +1,96 @@ +from django.core.exceptions import ValidationError +from workflow.models import Program, GaitID, FundCode +from django.core.management.base import BaseCommand +from django.db.utils import IntegrityError + + +class Command(BaseCommand): + """ + Command for moving saved gaitids under Program to a new GaitID table. + """ + help = "Moves gaitids saved under Program to their own GaitID table" + + def add_arguments(self, parser): + parser.add_argument('--execute', action='store_true', help='Without this flag, the command will only be a dry run') + parser.add_argument('--supress_output', action='store_true', help='Supresses the output so tests don\'t get too messy') + parser.add_argument('--clean', action='store_true', help='Cleans the database. Deletes GaitIDs and FundCodes created by execute.') + + def valid_int(self, value): + if value is None: + return False + try: + int(value) + return True + except ValueError: + return False + + + def handle(self, *args, **options): + if not options['execute'] and not options['supress_output'] and not options['clean']: + print('Dry Run') + + if options['clean']: + print('Cleaning the database') + + programs = Program.objects.all() + counts = { + 'gaitid': { + 'created': 0, + 'skipped': 0, + 'deleted': 0, + 'invalid': 0 + }, + 'fund_code': { + 'created': 0, + 'skipped': 0, + 'deleted': 0, + 'invalid': 0 + } + } + + if options['execute']: + for program in programs: + if self.valid_int(program.legacy_gaitid): + try: + gait_id = GaitID(program=program, gaitid=program.legacy_gaitid) + gait_id.save() + + counts['gaitid']['created'] += 1 + + if self.valid_int(program.cost_center): + try: + fund_code = FundCode(gaitid=gait_id, fund_code=program.cost_center) + fund_code.save() + counts['fund_code']['created'] += 1 + except IntegrityError: + counts['fund_code']['skipped'] += 1 + except ValidationError: + counts['fund_code']['invalid'] += 1 + else: + counts['fund_code']['invalid'] +=1 + + # Integrity error is raised when the unique_together constraint placed on program, gaitid fails + except IntegrityError: + counts['gaitid']['skipped'] += 1 + continue + else: + counts['gaitid']['invalid'] += 1 + + + if options['clean']: + gait_ids = GaitID.objects.all() + for gait_id in gait_ids: + gait_id.delete() + counts['gaitid']['deleted'] += 1 + # FundCodes get deleted if GaitID is deleted + counts['fund_code']['deleted'] += 1 + + if not options['supress_output']: + print('GAIT ids created: ', counts['gaitid']['created']) + print('Duplicate GAIT ids skipped: ', counts['gaitid']['skipped']) + print('GAIT ids deleted: ', counts['gaitid']['deleted']) + print('Gait ids invalid: ', counts['gaitid']['invalid']) + print('Fund codes created: ', counts['fund_code']['created']) + print('Duplicate fund codes skipped: ', counts['fund_code']['skipped']) + print('Fund codes deleted: ', counts['fund_code']['deleted']) + print('Fund codes invalid: ', counts['fund_code']['invalid']) diff --git a/workflow/migrations/0060_auto_20220420_1225.py b/workflow/migrations/0060_auto_20220420_1225.py new file mode 100644 index 000000000..13662d44c --- /dev/null +++ b/workflow/migrations/0060_auto_20220420_1225.py @@ -0,0 +1,48 @@ +# Generated by Django 3.2.12 on 2022-04-20 19:25 + +from django.db import migrations, models +import django.db.models.deletion +import workflow.validators + + +class Migration(migrations.Migration): + + dependencies = [ + ('workflow', '0059_program_external_program_id'), + ] + + operations = [ + migrations.RenameField( + model_name='program', + old_name='gaitid', + new_name='legacy_gaitid', + ), + migrations.CreateModel( + name='GaitID', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('gaitid', models.IntegerField()), + ('donor', models.TextField(null=True)), + ('donor_dept', models.TextField(null=True)), + ('create_date', models.DateTimeField(auto_now_add=True)), + ('edit_date', models.DateTimeField(auto_now=True)), + ('program', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='gaitid', to='workflow.program')), + ], + options={ + 'unique_together': {('gaitid', 'program')}, + }, + ), + migrations.CreateModel( + name='FundCode', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('fund_code', models.IntegerField(validators=[workflow.validators.validate_fund_code])), + ('create_date', models.DateTimeField(auto_now_add=True)), + ('edit_date', models.DateTimeField(auto_now=True)), + ('gaitid', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='workflow.gaitid')), + ], + options={ + 'unique_together': {('fund_code', 'gaitid')}, + }, + ), + ] diff --git a/workflow/models.py b/workflow/models.py index 720720b4c..62fa6af44 100755 --- a/workflow/models.py +++ b/workflow/models.py @@ -8,7 +8,7 @@ import uuid from django.utils.translation import ugettext_lazy as _ - +from workflow import validators from django.conf import settings from django.db.models import Count, Max, Min, Subquery, OuterRef, Q from django.db.models.signals import post_save @@ -516,11 +516,11 @@ class Program(models.Model): MIGRATED = 2 # programs created before satsuma which have switched to new RF levels RF_ALWAYS = 3 # programs created after satsuma release - on new RF levels with no option - gaitid = models.CharField(_("ID"), max_length=255, null=True, blank=True) + legacy_gaitid = models.CharField(_("ID"), max_length=255, null=True, blank=True) external_program_id = models.IntegerField(_('External program id'), null=True, blank=False) name = models.CharField(_("Program Name"), max_length=255, blank=True) funding_status = models.CharField(_("Funding Status"), max_length=255, blank=True) - cost_center = models.CharField(_("Fund Code"), max_length=255, blank=True, null=True) + cost_center = models.CharField(_("Fund Code"), max_length=255, blank=True, null=True) # Deprecated use program.gaitid.fund_code description = models.TextField(_("Program Description"), max_length=765, null=True, blank=True) sector = models.ManyToManyField(Sector, blank=True, verbose_name=_("Sector")) create_date = models.DateTimeField(null=True, blank=True) @@ -613,29 +613,18 @@ def program_page_url(self): """ return reverse('program_page', kwargs={'program': self.pk}) - @property - def gait_url(self): - """if program has a gait ID, returns url https://gait.mercycorps.org/editgrant.vm?GrantID=#### - otherwise returns false - """ - if self.gaitid is None: - return None - - try: - gaitid = int(self.gaitid) - except ValueError: - gaitid = False - if gaitid and gaitid != 0 and len(str(gaitid)) > 2 and len(str(gaitid)) < 5: - # gaitid exists, is numeric, is nonzero, and is a 3 or 4 digit number: - return 'https://gait.mercycorps.org/editgrant.vm?GrantID={gaitid}'.format( - gaitid=gaitid) - return None - def get_sites(self): indicator_ids = Indicator.objects.filter(program__in=[self.id]).values_list('id') results = Result.objects.filter(indicator__id__in=indicator_ids) return SiteProfile.objects.filter(result__id__in=results).distinct() + @property + def gaitids(self): + """ + Property to help with backwards compatibility with new GaitID table + """ + return list(self.gaitid.values_list('gaitid')) + @property def collected_record_count(self): return Program.objects.filter(pk=self.pk).annotate(num_data=Count('indicator__result')) \ @@ -707,7 +696,7 @@ def target_frequencies(self): @property def admin_logged_fields(self): return { - 'gaitid': self.gaitid, + 'gaitid': self.gaitids, 'name': self.name, 'funding_status': self.funding_status, 'cost_center': self.cost_center, @@ -767,6 +756,33 @@ def manual_numbering(self): return not self.results_framework or not self.auto_number_indicators +class GaitID(models.Model): + gaitid = models.IntegerField() + program = models.ForeignKey(Program, on_delete=models.CASCADE, related_name='gaitid') + donor = models.TextField(null=True) + donor_dept = models.TextField(null=True) + create_date = models.DateTimeField(auto_now_add=True) + edit_date = models.DateTimeField(auto_now=True) + + class Meta: + unique_together = ['gaitid', 'program'] + + def __str__(self): + return str(self.gaitid) + + +class FundCode(models.Model): + fund_code = models.IntegerField(validators=[validators.validate_fund_code]) + gaitid = models.ForeignKey(GaitID, on_delete=models.CASCADE) + create_date = models.DateTimeField(auto_now_add=True) + edit_date = models.DateTimeField(auto_now=True) + + class Meta: + unique_together = ['fund_code', 'gaitid'] + + def __str__(self): + return str(self.fund_code) + PROGRAM_ROLE_CHOICES = ( # Translators: Refers to a user permission role with limited access to view data only diff --git a/workflow/serializers_new/program_page_program_serializers.py b/workflow/serializers_new/program_page_program_serializers.py index 1af090c16..396502077 100644 --- a/workflow/serializers_new/program_page_program_serializers.py +++ b/workflow/serializers_new/program_page_program_serializers.py @@ -58,7 +58,6 @@ class ProgramPageMixin: needs_additional_target_periods = serializers.BooleanField() site_count = serializers.ReadOnlyField(source='num_sites') has_levels = serializers.SerializerMethodField() - gait_url = serializers.CharField() target_period_info = serializers.SerializerMethodField() class Meta: @@ -67,17 +66,11 @@ class Meta: 'needs_additional_target_periods', 'site_count', 'has_levels', - 'gait_url', 'target_period_info', ] # Class methods used to instantiate serializer with queryset and context to minimize queries - @classmethod - def _get_query_fields(cls): - """Extends parent's list of DB fields needed for included fields""" - return super()._get_query_fields() + ['gaitid'] - @classmethod def get_queryset(cls, **kwargs): """Loads program with annotations specific for program page display (note program_page_objects manager)""" diff --git a/workflow/tests/serializer_tests/program_page_program_serializers.py b/workflow/tests/serializer_tests/program_page_program_serializers.py index 0d402769b..3ae42677e 100644 --- a/workflow/tests/serializer_tests/program_page_program_serializers.py +++ b/workflow/tests/serializer_tests/program_page_program_serializers.py @@ -128,17 +128,6 @@ def test_level_count_nonzero(self): data = self.get_program_data(tiers=['Tier1', 'Tier2'], levels=2) self.assertTrue(data['has_levels']) - def test_gait_url_empty(self): - data = self.get_program_data(gaitid=None) - self.assertEqual(data['gait_url'], None) - - def test_gait_url(self): - data = self.get_program_data(gaitid=1423) - self.assertEqual( - data['gait_url'], - 'https://gait.mercycorps.org/editgrant.vm?GrantID=1423' - ) - def test_time_period_info_non_time_aware(self): p = RFProgramFactory() for frequency in [Indicator.LOP, Indicator.MID_END]: diff --git a/workflow/tests/test_gaitid.py b/workflow/tests/test_gaitid.py new file mode 100644 index 000000000..c939bf2af --- /dev/null +++ b/workflow/tests/test_gaitid.py @@ -0,0 +1,42 @@ +from factories.workflow_models import ProgramFactory +from workflow.models import GaitID +from django.db import transaction +from django.test import TestCase + + +class GaitIDTests(TestCase): + + def setUp(self): + self.program = ProgramFactory() + return super().setUp() + + def get_program_gaitid_count(self): + return GaitID.objects.filter(program=self.program).count() + + def create_gaitids(self, gaitid_list): + for gaitid in gaitid_list: + try: + with transaction.atomic(): + gait = GaitID(program=self.program, gaitid=gaitid) + gait.save() + except ValueError: + continue + + def test_one_gaitid(self): + expected_gaitid_count = 1 + + self.assertEqual(self.get_program_gaitid_count(), expected_gaitid_count) + + def test_multiple_gaitids(self): + gaitid_list = ['1234', '4555', '9743', '3456'] + expected_gaitid_count = 5 # 1 from the ProgramFactory and 4 from the list + self.create_gaitids(gaitid_list) + + self.assertEqual(self.get_program_gaitid_count(), expected_gaitid_count) + + def test_multiple_gaitids_some_invalid(self): + gaitid_list = ['abc', '1234', '8643', '1-a'] + expected_gaitid_count = 3 + self.create_gaitids(gaitid_list) + + self.assertEqual(self.get_program_gaitid_count(), expected_gaitid_count) diff --git a/workflow/tests/test_model_validators.py b/workflow/tests/test_model_validators.py new file mode 100644 index 000000000..b9e356c4a --- /dev/null +++ b/workflow/tests/test_model_validators.py @@ -0,0 +1,45 @@ +from factories.workflow_models import ProgramFactory +from django.core.exceptions import ValidationError +from workflow.models import FundCode, GaitID +from django.test import TestCase + + +class FundCodeValidatorTest(TestCase): + + def setUp(self): + self.program = ProgramFactory() + self.gaitid = GaitID.objects.get(program_id=self.program.id) + return super().setUp() + + def fund_code_len(self): + return FundCode.objects.filter(gaitid=self.gaitid).count() + + def test_invalid_fund_code(self): + invalid_fund_codes = [45000, 'abc', 0.245, '12345'] + + for invalid_fund_code in invalid_fund_codes: + fund_code = FundCode(gaitid=self.gaitid, fund_code=invalid_fund_code) + + self.assertRaises(ValidationError, fund_code.full_clean) + self.assertEqual(self.fund_code_len(), 0) + + def test_valid_fund_code(self): + valid_fund_code = 35000 + fund_code = FundCode(gaitid=self.gaitid, fund_code=valid_fund_code) + + try: + fund_code.full_clean() + fund_code.save() + except ValidationError: + self.fail('Received ValidationError on FundCodeValidatorTest.test_valid_fund_code') + + self.assertEqual(self.fund_code_len(), 1) + + def test_multiple_valid_fund_code(self): + valid_fund_codes = [33000, 34000, 35000, 74000, 92000] + + for valid_fund_code in valid_fund_codes: + fund_code = FundCode(gaitid=self.gaitid, fund_code=valid_fund_code) + fund_code.save() + + self.assertEqual(self.fund_code_len(), 5) diff --git a/workflow/validators.py b/workflow/validators.py new file mode 100644 index 000000000..56cef1f8b --- /dev/null +++ b/workflow/validators.py @@ -0,0 +1,12 @@ +from django.core.exceptions import ValidationError + + +def validate_fund_code(value): + fund_code_ranges = [range(30000, 39999), range(70000, 79000), range(90000, 99999)] + + for fund_code_range in fund_code_ranges: + if value in fund_code_range: + return True + + # Not sure if this error should be translated. With the automatic program creation this error would only be present on the backend. + raise ValidationError('Received invalid fund code') \ No newline at end of file From 890b679b666b9c5fd6e26dcef5a3d742393ef135 Mon Sep 17 00:00:00 2001 From: Andre Thomas Date: Mon, 9 May 2022 14:22:24 -0400 Subject: [PATCH 002/235] For mercycorps/TolaActivity#2769, removed the add program button for all except demo and django admin. --- js/pages/tola_management_pages/program/views.js | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/js/pages/tola_management_pages/program/views.js b/js/pages/tola_management_pages/program/views.js index a5b4ede4d..b6f795df9 100644 --- a/js/pages/tola_management_pages/program/views.js +++ b/js/pages/tola_management_pages/program/views.js @@ -207,11 +207,13 @@ export const IndexView = observer(
-
- store.createProgram()}> - {gettext("Add Program")} - -
+ {window.location.href.toLowerCase().includes('demo') && + + }
From 8cfb3d40d2528abafd1be2bc8ecf9d3b23bb5a85 Mon Sep 17 00:00:00 2001 From: Andre Thomas Date: Mon, 9 May 2022 15:19:48 -0400 Subject: [PATCH 003/235] removed gait_url from backend serializer, model, and tests. --- templates/indicators/program_page.html | 4 ++-- workflow/models.py | 18 ------------------ .../program_page_program_serializers.py | 2 -- .../program_page_program_serializers.py | 11 ----------- 4 files changed, 2 insertions(+), 33 deletions(-) diff --git a/templates/indicators/program_page.html b/templates/indicators/program_page.html index 83d95645d..3e0ac52d0 100755 --- a/templates/indicators/program_page.html +++ b/templates/indicators/program_page.html @@ -37,10 +37,10 @@

{% trans "Program details" %}

{% endif %}
  • {% trans "Change log" %}
  • {% trans "Indicator plan" %}
    • - {% if program.gait_url %} +
    diff --git a/workflow/models.py b/workflow/models.py index 720720b4c..af6167300 100755 --- a/workflow/models.py +++ b/workflow/models.py @@ -613,24 +613,6 @@ def program_page_url(self): """ return reverse('program_page', kwargs={'program': self.pk}) - @property - def gait_url(self): - """if program has a gait ID, returns url https://gait.mercycorps.org/editgrant.vm?GrantID=#### - otherwise returns false - """ - if self.gaitid is None: - return None - - try: - gaitid = int(self.gaitid) - except ValueError: - gaitid = False - if gaitid and gaitid != 0 and len(str(gaitid)) > 2 and len(str(gaitid)) < 5: - # gaitid exists, is numeric, is nonzero, and is a 3 or 4 digit number: - return 'https://gait.mercycorps.org/editgrant.vm?GrantID={gaitid}'.format( - gaitid=gaitid) - return None - def get_sites(self): indicator_ids = Indicator.objects.filter(program__in=[self.id]).values_list('id') results = Result.objects.filter(indicator__id__in=indicator_ids) diff --git a/workflow/serializers_new/program_page_program_serializers.py b/workflow/serializers_new/program_page_program_serializers.py index 1af090c16..5f28e1a04 100644 --- a/workflow/serializers_new/program_page_program_serializers.py +++ b/workflow/serializers_new/program_page_program_serializers.py @@ -58,7 +58,6 @@ class ProgramPageMixin: needs_additional_target_periods = serializers.BooleanField() site_count = serializers.ReadOnlyField(source='num_sites') has_levels = serializers.SerializerMethodField() - gait_url = serializers.CharField() target_period_info = serializers.SerializerMethodField() class Meta: @@ -67,7 +66,6 @@ class Meta: 'needs_additional_target_periods', 'site_count', 'has_levels', - 'gait_url', 'target_period_info', ] diff --git a/workflow/tests/serializer_tests/program_page_program_serializers.py b/workflow/tests/serializer_tests/program_page_program_serializers.py index 0d402769b..3ae42677e 100644 --- a/workflow/tests/serializer_tests/program_page_program_serializers.py +++ b/workflow/tests/serializer_tests/program_page_program_serializers.py @@ -128,17 +128,6 @@ def test_level_count_nonzero(self): data = self.get_program_data(tiers=['Tier1', 'Tier2'], levels=2) self.assertTrue(data['has_levels']) - def test_gait_url_empty(self): - data = self.get_program_data(gaitid=None) - self.assertEqual(data['gait_url'], None) - - def test_gait_url(self): - data = self.get_program_data(gaitid=1423) - self.assertEqual( - data['gait_url'], - 'https://gait.mercycorps.org/editgrant.vm?GrantID=1423' - ) - def test_time_period_info_non_time_aware(self): p = RFProgramFactory() for frequency in [Indicator.LOP, Indicator.MID_END]: From b2f7c46e88658affb630bba4f83ab827d571fe02 Mon Sep 17 00:00:00 2001 From: Andre Thomas Date: Tue, 10 May 2022 13:28:25 -0400 Subject: [PATCH 004/235] Removed commented out gait_url code. --- templates/indicators/program_page.html | 4 ---- 1 file changed, 4 deletions(-) diff --git a/templates/indicators/program_page.html b/templates/indicators/program_page.html index 3e0ac52d0..856655f17 100755 --- a/templates/indicators/program_page.html +++ b/templates/indicators/program_page.html @@ -37,10 +37,6 @@

    {% trans "Program details" %}

    {% endif %}
  • {% trans "Change log" %}
  • {% trans "Indicator plan" %}
    • -
    From 187879a2a16ab478267341e451dae3bea3de9137 Mon Sep 17 00:00:00 2001 From: Andre Thomas Date: Thu, 12 May 2022 11:27:02 -0400 Subject: [PATCH 005/235] Created the Program Period modal using React. --- .../program_page/components/program_period.js | 117 ++++++++++++++++++ js/pages/program_page/index.js | 5 +- .../indicators/tags/program-complete.html | 9 +- 3 files changed, 128 insertions(+), 3 deletions(-) create mode 100644 js/pages/program_page/components/program_period.js diff --git a/js/pages/program_page/components/program_period.js b/js/pages/program_page/components/program_period.js new file mode 100644 index 000000000..bca313a7e --- /dev/null +++ b/js/pages/program_page/components/program_period.js @@ -0,0 +1,117 @@ +import React from 'react' + +const ProgramPeriod = () => { + return ( + + + { + gettext("Program Period") + } + + + + + ) +} + +export { ProgramPeriod }; diff --git a/js/pages/program_page/index.js b/js/pages/program_page/index.js index 8b0653b29..f7086afce 100644 --- a/js/pages/program_page/index.js +++ b/js/pages/program_page/index.js @@ -10,6 +10,7 @@ import ProgramPageRootStore from './models/programPageRootStore'; import { reloadPageIfCached } from '../../general_utilities'; import { IndicatorFilterType } from '../../constants'; import SitesList from './components/sitesList'; +import { ProgramPeriod } from './components/program_period'; import setupPinningDelete from './pinned_reports'; @@ -90,8 +91,10 @@ ReactDOM.render(, document.querySelector('#program-metrics-react-component')); ReactDOM.render(, - document.querySelector('#sites-sidebar')); + document.querySelector('#sites-sidebar')); +ReactDOM.render(, + document.querySelector('.programperiodlink')); /* * Copied and modified JS from indicator_list_modals.js to allow modals to work diff --git a/templates/indicators/tags/program-complete.html b/templates/indicators/tags/program-complete.html index b20b8fe35..764cca13e 100644 --- a/templates/indicators/tags/program-complete.html +++ b/templates/indicators/tags/program-complete.html @@ -3,7 +3,12 @@

    {% blocktrans %} - + Program period + + is
    {{ program.percent_complete }}% complete {% endblocktrans %}

    From a94563176479c8d1f596044d2a0257635a380cf2 Mon Sep 17 00:00:00 2001 From: Blake Long Date: Tue, 17 May 2022 08:12:57 -0600 Subject: [PATCH 006/235] Validation class for validating tola and idaa programs --- workflow/program.py | 277 ++++++++++++++++++ .../tests/idaa_sample_data/idaa_sample.json | 55 ++++ workflow/tests/test_program_upload_class.py | 204 +++++++++++++ 3 files changed, 536 insertions(+) create mode 100644 workflow/program.py create mode 100644 workflow/tests/idaa_sample_data/idaa_sample.json create mode 100644 workflow/tests/test_program_upload_class.py diff --git a/workflow/program.py b/workflow/program.py new file mode 100644 index 000000000..5e754a7ca --- /dev/null +++ b/workflow/program.py @@ -0,0 +1,277 @@ +from workflow import models +import datetime +import re + + +def convert_date(date, format='%m/%d/%Y'): + """ + Converts date to Django date format + """ + to_format = '%Y-%m-%d' + + return datetime.datetime.strptime(date, format).strftime(to_format) + + +class ProgramDiscrepancies: + # TODO: It may be better to move the reasons to the table. And only pass in the keys that have a discrepancy? + _discrepancy_reasons = { + "funding_status": "Tola funding status does not match IDAA ProgramStatus", + "start_date": "Tola start date does not match IDAA ProgramStartDate", + "end_date": "Tola end date does not match IDAA ProgramEndDate", + "countries": "Tola program countries does not match IDAA Country", + "multiple_programs": "Multiple Tola programs retrieved from IDAA program", + "funded": "IDAA program is not funded", + "gaitid": "IDAA program has invalid Gait ID", + "ProgramName": "IDAA program is missing ProgramName", + "ID": "IDAA program is missing ID", + "ProgramStartDate": "IDAA program is missing ProgramStartDate", + "ProgramEndDate": "IDAA program is missing ProgramEndDate", + "ProgramStatus": "IDAA program is missing ProgramStatus", + "Country": "IDAA program is missing Country" + } + + def __init__(self, execute=False): + self.execute = execute + self._discrepancies = set() + + @property + def discrepancies(self): + return self._discrepancies + + @property + def discrepancy_reasons(self): + return self._get_discrepancy_reasons() + + @property + def discrepancy_count(self): + return len(self._discrepancies) + + def has_discrepancy(self, discrepancy): + return discrepancy in self._discrepancies + + def _get_discrepancy_reasons(self): + reasons = [] + + for discrepancy in self._discrepancies: + reasons.append(self._discrepancy_reasons[discrepancy]) + + return reasons + + def add_discrepancy(self, discrepancy): + self._discrepancies.add(discrepancy) + + def create_discrepancies(self): + if self.execute: + # TODO: add discrepancy to ProgramDiscrepancy table? + pass + + +class ProgramValidation(ProgramDiscrepancies): + funded_str = 'Funded' + + def __init__(self, idaa_program, execute=False): + self.idaa_program = idaa_program + self.execute = execute + self._validated = False + + super().__init__(execute) + + @property + def tola_program_exists(self): + return not self.tola_program is None + + @property + def validated(self): + """ + Property to check that is_valid was called + """ + return self._validated + + def program_is_funded(self): + """ + Checks that the IDAA program is funded + """ + funded = self.idaa_program['ProgramStatus'] == self.funded_str + + if not funded: + self.add_discrepancy('funded') + + return funded + + def valid_gaitids(self): + """ + Loops through IDAA gait ids and checks that each one is valid + """ + valid = True + + if len(self.idaa_program['GaitIDs']) == 0: + valid = False + else: + for gaitid in self.idaa_program['GaitIDs']: + if gaitid == 0: + valid = False + else: + try: + int(gaitid) + except ValueError: + valid = False + + if not valid: + self.add_discrepancy('gaitid') + + return valid + + def missing_fields(self): + """ + Checks that idaa_program is not missing any fields + """ + fields = ["ID", "ProgramName", "ProgramStartDate", "ProgramEndDate", "ProgramStatus", "Country"] + missing = False + + for field in fields: + if field not in self.idaa_program or self.idaa_program[field] == '' or self.idaa_program[field] is None: + self.add_discrepancy(field) + missing = True + + return missing + + def valid_idaa_program(self): + """ + Validation for idaa programs + - program is funded + - program has valid gaitid + - program has no missing fields + """ + return not self.missing_fields() and self.program_is_funded() and self.valid_gaitids() + + def matching_fields(self): + """ + Checks that the values between required fields are the same between Tola and IDAA + """ + fields = [ + {'idaa': 'ProgramStatus', 'tola': 'funding_status'}, + {'idaa': 'ProgramStartDate', 'tola': 'start_date'}, + {'idaa': 'ProgramEndDate', 'tola': 'end_date'} + ] + matching = True + + for field in fields: + tola_value = getattr(self.tola_program, field['tola']) + idaa_value = self.idaa_program[field['idaa']] + + # Need to convert IDAA dates to Tola date format + if field['idaa'] == 'ProgramStartDate' or field['idaa'] == 'ProgramEndDate': + idaa_value = convert_date(idaa_value) + + if not str(tola_value) == idaa_value: + self.add_discrepancy(field['tola']) + matching = False + + return matching + + def matching_countries(self): + """ + Checks if the IDAA and Tola programs have the same countries + """ + tola_countries = [country.name for country in self.tola_program.country.all()] + idaa_countries = set(country.strip() for country in re.split(',|;', self.idaa_program['Country'])) + matching = True + + if len(tola_countries) == 0: + self.add_discrepancy('countries') + matching = False + else: + for idaa_country in idaa_countries: + if idaa_country in tola_countries: + # Countries matched, remove from tola_countries + tola_countries.remove(idaa_country) + else: + self.add_discrepancy('countries') + matching = False + + # If tola_countries still has items, then the countries did not fully match + if len(tola_countries) > 0: + self.add_discrepancy('countries') + matching = False + + return matching + + def valid_tola_program(self): + """ + Validation for tola programs + - program fields match + - countires match + """ + return self.matching_fields() and self.matching_countries() + + def is_valid(self): + """ + Method for checking if the program upload is valid. Checks the IDAA program and if possible the Tola program aswell. + """ + # These discrepancies can come up while trying to retrieve the Tola program + if self.has_discrepancy('multiple_programs') or self.has_discrepancy('gaitid'): + return False + + valid_idaa_program = self.valid_idaa_program() + + # Validate the Tola program if one exists + if self.tola_program_exists: + valid_tola_program = self.valid_tola_program() + + self._validated = valid_idaa_program and valid_tola_program + + return valid_idaa_program and valid_tola_program + + self._validated = valid_idaa_program + + return valid_idaa_program + + +class ProgramUpload(ProgramValidation): + + def __init__(self, idaa_program, execute=False): + self.idaa_program = idaa_program + self.execute = execute + + super().__init__(idaa_program, execute) + + self.tola_program = self.get_tola_programs() + + @property + def new_upload(self): + return not self.tola_program_exists + + def get_tola_programs(self): + """ + Queries the Program table for Tola programs that have the IDAA program gait ids + """ + try: + return models.Program.objects.get(gaitid__gaitid__in=self.idaa_program['GaitIDs']) + except models.Program.DoesNotExist: + # Program does not exist in Tola - this is a new upload + return None + except models.Program.MultipleObjectsReturned: + # Multiple Tola programs returned. Add the multiple_programs discrepancy since it would be impossible to know which Tola program needs validated + self.add_discrepancy('multiple_programs') + except ValueError: + # IDAA gait id is invalid (not an int) + self.add_discrepancy('gaitid') + except KeyError: + # IDAA's json response did not include a gait id + self.add_discrepancy('gaitid') + + def update(self): + pass + + def create(self): + pass + + def upload(self): + # TODO: Before creating or updating need to clean fields + if not self.validated: + raise Exception(f"Can not upload program. {self.idaa_program['ProgramName']} is either invalid or the method is_valid() has not been called yet.") + + if self.new_upload: + self.create() + else: + self.update() diff --git a/workflow/tests/idaa_sample_data/idaa_sample.json b/workflow/tests/idaa_sample_data/idaa_sample.json new file mode 100644 index 000000000..6b4a30058 --- /dev/null +++ b/workflow/tests/idaa_sample_data/idaa_sample.json @@ -0,0 +1,55 @@ +{ + "d": { + "results": [ + { + "ID": 1554, + "ProgramName": "[CN] Annual Process for Responding to Humanitarian Situations 2020", + "GaitIDs": [10347], + "ProgramStatus": "Rejected", + "Country": "Colombia", + "ProgramStartDate": "12/01/2021", + "ProgramEndDate": "12/01/2022" + }, + { + "ID": 1575, + "ProgramName": "2021 TIDES/Upwork Foundation Grant", + "GaitIDs": [10864], + "ProgramStatus": "Funded", + "Country": "Palestine, State of", + "Region": "Middle East", + "ProgramStartDate": "12/23/2021", + "ProgramEndDate": "12/22/2022" + }, + { + "ID": 1576, + "ProgramName": "2021 Timor-Leste Cyclone Seroja Flood Response", + "GaitIDs": [10476], + "ProgramStatus": "Funded", + "Country": "Timor-Leste", + "Region": "Asia", + "ProgramStartDate": "7/19/2021", + "ProgramEndDate": "4/18/2022" + }, + { + "ID": 1609, + "ProgramName": "AI for Social Good", + "GaitIDs": [10521], + "ProgramStatus": "Funded", + "Country": "HQ", + "Region": "HQ Managed", + "ProgramStartDate": "11/24/2020", + "ProgramEndDate": "11/30/2021" + }, + { + "ID": 1000, + "ProgramName": "Multiple GAIT ids test", + "GaitIDs": [10254, 10974], + "ProgramStatus": "Funded", + "Country": "HQ", + "Region": "HQ Managed", + "ProgramStartDate": "5/12/2022", + "ProgramEndDate": "5/12/2023" + } + ] + } +} \ No newline at end of file diff --git a/workflow/tests/test_program_upload_class.py b/workflow/tests/test_program_upload_class.py new file mode 100644 index 000000000..0683bbee8 --- /dev/null +++ b/workflow/tests/test_program_upload_class.py @@ -0,0 +1,204 @@ +from factories import workflow_models +from workflow import program +from django import test +import json +import copy + + +class TestProgramUpload(test.TestCase): + idaa_sample_data_path = 'workflow/tests/idaa_sample_data/idaa_sample.json' + create_idaa_program_index = 2 + idaa_json = None + + def setUp(self): + """ + Need to create a program that is from the idaa sample + """ + with open(self.idaa_sample_data_path) as file: + self.idaa_json = json.load(file) + + target_idaa_program = self.idaa_json['d']['results'][self.create_idaa_program_index] + + self._create_tola_program(target_idaa_program, fields={ + "name": target_idaa_program['ProgramName'], + "funding_status": target_idaa_program['ProgramStatus'], + "start_date": program.convert_date(target_idaa_program['ProgramStartDate']), + "end_date": program.convert_date(target_idaa_program['ProgramEndDate']) + }) + + def _create_tola_program(self, idaa_program, fields, create_country=True): + """ + Creates a Tola program + """ + if create_country: + country = workflow_models.CountryFactory( + country=idaa_program['Country'] + ) + fields['countries'] = [country] + + new_program = workflow_models.ProgramFactory(**fields) + + workflow_models.GaitIDFactory( + gaitid=idaa_program['GaitIDs'][0], + program_id=new_program.id + ) + + def test_validation_idaa_not_funded(self): + """ + Test validation when an IDAA program is not funded + """ + idaa_not_funded_index = 0 + expected_discrepancies = 1 + + upload_program = program.ProgramUpload(idaa_program=self.idaa_json['d']['results'][idaa_not_funded_index]) + + self.assertFalse(upload_program.is_valid()) + self.assertTrue(upload_program.has_discrepancy('funded')) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + + def test_validation_idaa_valid_and_exists(self): + """ + Test validation when an IDAA program is valid and exists in Tola + """ + expected_discrepancies = 0 + + upload_program = program.ProgramUpload(idaa_program=self.idaa_json['d']['results'][self.create_idaa_program_index]) + + self.assertTrue(upload_program.is_valid()) + self.assertTrue(upload_program.tola_program_exists) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + + def test_validation_idaa_valid_and_does_not_exists(self): + """ + Test validation when an IDAA program is valid and does not exist in Tola + """ + idaa_index = 1 + expected_discrepancies = 0 + + upload_program = program.ProgramUpload(idaa_program=self.idaa_json['d']['results'][idaa_index]) + + self.assertTrue(upload_program.is_valid()) + self.assertFalse(upload_program.tola_program_exists) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + + def test_invalid_countries_tola_program(self): + """ + Test validation when a Tola program has mismatching countries to the IDAA program + """ + idaa_index = 3 + expected_discrepancies = 1 + + idaa_program = self.idaa_json['d']['results'][idaa_index] + + self._create_tola_program(idaa_program, fields={ + "name": idaa_program['ProgramName'], + "funding_status": idaa_program['ProgramStatus'], + "start_date": program.convert_date(idaa_program['ProgramStartDate']), + "end_date": program.convert_date(idaa_program['ProgramEndDate']), + }, create_country=False) + + upload_program = program.ProgramUpload(idaa_program=idaa_program) + + self.assertFalse(upload_program.is_valid()) + self.assertTrue(upload_program.tola_program_exists) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + self.assertTrue(upload_program.has_discrepancy('countries')) + + def test_invalid_fields_tola_program(self): + """ + Test validation when a Tola program has mismatching fields to the IDAA program + """ + idaa_index = 3 + expected_discrepancies = 2 + + idaa_program = self.idaa_json['d']['results'][idaa_index] + + self._create_tola_program(idaa_program, fields={ + "name": idaa_program['ProgramName'], + "funding_status": idaa_program['ProgramStatus'], + "start_date": "2022-05-12", + "end_date": "2022-08-01" + }) + + upload_program = program.ProgramUpload(idaa_program=idaa_program) + + self.assertFalse(upload_program.is_valid()) + self.assertTrue(upload_program.tola_program_exists) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + self.assertTrue(upload_program.has_discrepancy('start_date')) + self.assertTrue(upload_program.has_discrepancy('end_date')) + + def test_invalid_gaitid_idaa_program(self): + """ + Test validation when an IDAA program has invalid GaitIDs + """ + idaa_index = 3 + expected_discrepancies = 1 + + idaa_program = self.idaa_json['d']['results'][idaa_index] + + idaa_program['GaitIDs'][0] = '123a' + + upload_program = program.ProgramUpload(idaa_program=idaa_program) + + self.assertFalse(upload_program.is_valid()) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + self.assertTrue(upload_program.has_discrepancy('gaitid')) + + def test_missing_gaitid_idaa_program(self): + """ + Test validation when an IDAA program does not have a Gait id + """ + idaa_index = 3 + expected_discrepancies = 1 + + idaa_program = self.idaa_json['d']['results'][idaa_index] + + idaa_program['GaitIDs'] = [] + + upload_program = program.ProgramUpload(idaa_program=idaa_program) + + self.assertFalse(upload_program.is_valid()) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + self.assertTrue(upload_program.has_discrepancy('gaitid')) + + def test_each_field_empty_idaa_program(self): + """ + Test validation when an IDAA program has an empty required field + """ + fields = ["ID", "ProgramName", "ProgramStartDate", "ProgramEndDate", "ProgramStatus", "Country"] + idaa_index = 3 + expected_discrepancies = 1 + + for field in fields: + idaa_program = copy.copy(self.idaa_json['d']['results'][idaa_index]) + + idaa_program[field] = '' + + upload_program = program.ProgramUpload(idaa_program=idaa_program) + + self.assertFalse(upload_program.is_valid()) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + self.assertTrue(upload_program.has_discrepancy(field)) + + def test_mulitple_idaa_gaitids(self): + """ + Test validation when an IDAA program has multiple gait ids + """ + idaa_index = 4 + expected_discrepancies = 0 + + upload_program = program.ProgramUpload(idaa_program=self.idaa_json['d']['results'][idaa_index]) + + self.assertTrue(upload_program.is_valid()) + self.assertEquals(upload_program.discrepancy_count, expected_discrepancies) + + def test_skip_is_valid(self): + """ + Test that upload raises correctly when is_valid was not called + """ + idaa_index = 3 + + upload_program = program.ProgramUpload(idaa_program=self.idaa_json['d']['results'][idaa_index]) + + self.assertRaises(Exception, upload_program.upload) From 396b6d2cb2a58b9865eb19776c02760ea540be6a Mon Sep 17 00:00:00 2001 From: Andre Thomas Date: Tue, 17 May 2022 13:10:45 -0400 Subject: [PATCH 007/235] Updated the indicator tracking end date. --- .../program_page/components/program_period.js | 161 +++++++++++++++--- .../components/CommonFields.js | 3 +- .../indicators/tags/program-complete.html | 8 +- 3 files changed, 147 insertions(+), 25 deletions(-) diff --git a/js/pages/program_page/components/program_period.js b/js/pages/program_page/components/program_period.js index bca313a7e..ccc056ded 100644 --- a/js/pages/program_page/components/program_period.js +++ b/js/pages/program_page/components/program_period.js @@ -1,6 +1,126 @@ -import React from 'react' +import React, { useState, useEffect } from 'react'; +import api from '../../../apiv2'; const ProgramPeriod = () => { + + let sampleData = { + program: { + id: 983, + // start_date: "2020-09-01", + // end_date: "2023-04-30", + start_date: "unavailable", + end_date: "unavailable", + reporting_period_start: "2020-09-01", + reporting_period_end: "2023-04-30", + }, + read_only: false, + } + + function processDateString(datestr) { + // take a date string, return a Date, for datepickers, handles iso dates and human input dates + //check for an iso date, and if so parse it with regex (to avoid 0 padding glitches on chrome) + var isodate = /(\d{4})\-(\d{1,2})\-(\d{1,2})/.exec(datestr); + var defaultDate; + if (isodate !== null) { + //regex found an iso date, instance a date from the regex parsing: + //note: month is 0-index in JS because reasons, so -1 to parse human iso date: + defaultDate = new Date(isodate[1], isodate[2]-1, isodate[3]); + } else { + defaultDate = new Date( + datestr.substring(datestr.length - 4, datestr.length), + jQuery.inArray(datestr.substring(0, 3), $(this).datepicker('option', 'monthNamesShort')) + 1, + 0 + ); + } + return defaultDate; + } + + const [programPeriodInputs, setProgramPeriodInputs] = useState({ + indicator_tracking_start_date: sampleData.program.reporting_period_start, + indicator_tracking_end_date: sampleData.program.reporting_period_end, + }); + + useEffect(() => { + // Setup Date pickers + const commonOpts = { + changeMonth: true, + changeYear: true, + showButtonPanel: true, + dateFormat: 'yy-mm-dd', + }; + + $('#indicator-tracking__date--end').datepicker( + $.extend(true, commonOpts, { + beforeShow: function(input, inst) { + $("#ui-datepicker-div").addClass("month-only"); + // The datepicker will preserve the minDate option from its last use, so we need to reset it + // before we set the input field value. + $(this).datepicker('option', 'minDate', "-10y"); + let datestr; + if ((datestr = $(this).val()).length > 0) { + var defaultDate = processDateString(datestr); + $(this).datepicker('option', 'defaultDate', defaultDate); + $(this).datepicker('setDate', defaultDate); + } + else { + $(this).datepicker('option', 'defaultDate', new Date()); + } + + // If there are dated periodic targets associated with the program, set the minDate to the maximum + // start value of all periodic target periods. Otherwise, if the start date field has a value, + // set the minDate to that value. + if (max_target_start) { + dateParts = max_target_start.split('-') + year = parseInt(dateParts[0]) + month = parseInt(dateParts[1]) + $(this).datepicker('option', 'minDate', new Date(year, month, 0)); + } + else if ((selectedDate = $(`#${start_date_id}`).val()).length > 0) { + let selectedStartDate = processDateString(selectedDate); + $(this).datepicker("option", "minDate", new Date(selectedStartDate.getFullYear(), selectedStartDate.getMonth()+1, 0)); + } + } + }) + ).focus(function(){ + const field = $(this); + // hide the days part of the calendar + $(".ui-datepicker-calendar").hide(); + // hide the "Today" button + $("#ui-datepicker-div button.ui-datepicker-current").hide(); + $("#ui-datepicker-div").position({ + my: "left top", + at: "left bottom", + of: $(this) + }); + // detach it from the field so that onclose the field is not populated automatically + $('.ui-datepicker-calendar').detach(); + $('.ui-datepicker-close').on("click", function() { + // this is only called when the done button is clicked. + const month = $("#ui-datepicker-div .ui-datepicker-month :selected").val(); + const year = $("#ui-datepicker-div .ui-datepicker-year :selected").val(); + field.datepicker('setDate', new Date(year, parseInt(month)+1, 0)); + field.trigger('change'); + }); + }) + + $('#indicator-tracking__date--start').datepicker("setDate", programPeriodInputs.indicator_tracking_start_date) + $('#indicator-tracking__date--end').datepicker("setDate", programPeriodInputs.indicator_tracking_end_date) + + $('#indicator-tracking__date--end').on('change', () => { + let date = $('#indicator-tracking__date--end').datepicker('getDate'); + console.log("Datepicker:", date); + // setProgramPeriodInputs({...programPeriodInputs, indicator_tracking_start_date}) + }) + }, []) + + // Get data on mount with API Call + + // Send updated data with API Call + + // Validate data + + + return ( {