tests/testthat/test-getValidOrgUnits.R

In pepfar-datim/datapackr: A Package that Packs and Unpacks all Data Packs and Target Setting Tools

context("Valid orgunit structure")

test_that("Can error on a missing cop year", {
  expect_error(getValidOrgUnits(NULL))
  expect_error(getValidOrgUnits(NA))
  expect_error(getValidOrgUnits(c(2021, 2022)))
  expect_silent(getValidOrgUnits(getCurrentCOPYear()))

})


test_that(
  "Structure of orgunits is the defined pre 2025",
  {
    all_cop_years <- supportedCOPYears()[supportedCOPYears() %in% c("2024")]
    expect_silent(all_orgunits <-
                    lapply(all_cop_years, getValidOrgUnits))

    expected_names <- c(
      "name",
      "uid",
      "org_type",
      "ou",
      "ou_uid",
      "country_name",
      "country_uid",
      "snu1",
      "snu1_uid",
      "lastUpdated",
      "ancestors",
      "organisationUnitGroups",
      "DREAMS"
    )

    expect_true(all(purrr::map_lgl(
      all_orgunits, ~ setequal(names(.x), expected_names)
    )))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(is_uidish(
      .x$uid
    )))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$ou_uid)
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$snu1_uid)
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$country_uid)
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ is.list(.x$ancestors))))

    expect_true(all(purrr::map_lgl(
      all_orgunits, ~ is.list(.x$organisationUnitGroups)
    )))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ is.integer(
      as.integer(as.Date(.x$lastUpdated, origin = "1970-01-01"))
    ))))


  })

test_that(
  "Structure of orgunits is the defined in 2025 above",
  {
    all_cop_years <- supportedCOPYears()[supportedCOPYears() %in% c("2025")]
    expect_silent(all_orgunits <-
                    lapply(all_cop_years, getValidOrgUnits))

    expected_names <- c(
      "name",
      "uid",
      "org_type",
      "ou",
      "ou_uid",
      "country_name",
      "country_uid",
      "snu1",
      "snu1_uid",
      "lastUpdated",
      "ancestors",
      "organisationUnitGroups",
      "DREAMS",
      "tsnu",
      "country_was_psnu"
    )

    expect_true(all(purrr::map_lgl(
      all_orgunits, ~ setequal(names(.x), expected_names)
    )))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(is_uidish(
      .x$uid
    )))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$ou_uid[.x$org_type != "Country"])
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$snu1_uid)
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ all(
      is_uidish(.x$country_uid)
    ))))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ is.list(.x$ancestors))))

    expect_true(all(purrr::map_lgl(
      all_orgunits, ~ is.list(.x$organisationUnitGroups)
    )))

    expect_true(all(purrr::map_lgl(all_orgunits, ~ is.integer(
      as.integer(as.Date(.x$lastUpdated, origin = "1970-01-01"))
    ))))


  })


test_that(
  "We can differentiate between psnus that are tsnus",
  {

    # each test case
    pick <- datapackr::cop25_datapack_countries %>%
      dplyr::filter(datapack_name %in% c("Cameroon", "Rwanda", "Peru"))

    # Cameroon TSNUS should also be PSNUs
    # we expect all psnus to line up as tsnus with the TSNU flag
    cam <- getValidOrgUnits("2025") %>%
      dplyr::filter(country_uid %in% pick$country_uids) %>%
      dplyr::filter(org_type == "PSNU" & country_name == "Cameroon") %>%
      dplyr::pull(tsnu) %>%
      unique()

    expect_false(any(is.na(cam)))

    # rwanda will need psnus for all prioritization so TSNU flag should be empty
    rwan <- getValidOrgUnits("2025") %>%
      dplyr::filter(country_uid %in% pick$country_uids) %>%
      dplyr::filter(org_type == "PSNU" & country_name == "Rwanda") %>%
      dplyr::pull(tsnu) %>%
      unique()

    expect_true(all(is.na(rwan)))

    # what if country used to be a psnu in a region?
    # peru sets targets at national level, but even tho
    # has no regional psnus it requires national level as a psnu
    # for prioritization tab
    peru <- getValidOrgUnits("2025") %>%
      dplyr::filter(country_uid %in% pick$country_uids) %>%
      dplyr::filter(country_name == "Peru" & org_type != "Military") %>%
      dplyr::select(name, org_type, tsnu, country_was_psnu)

    expect_true(
      identical(
        peru$country_was_psnu,
        "Y"
      )
    )

    # rwanda is not historically a national level psnu so flag should be empty
    rwan <- getValidOrgUnits("2025") %>%
      dplyr::filter(country_uid %in% pick$country_uids) %>%
      dplyr::filter(country_name == "Rwanda" & org_type != "Military") %>%
      dplyr::select(name, org_type, tsnu, country_was_psnu)

    expect_true(all(is.na(rwan$country_was_psnu)))

  })