tests/testthat/test-createRangeGate.R

In primitybio/cellengine-r-toolkit: 'CellEngine' API Toolkit

context("createRangeGate")

test_that("Correct HTTP request is made", {
  with_mock(
    `httr::request_perform` = function(req, handle, refresh) {
      expect_equal(req$method, "POST")
      expect_equal(req$url, "https://my.server.com/api/v1/experiments/591a3b441d725115208a6fda/gates")
      body <- rawToChar(req$options$postfields)
      # Literal except for the gid value
      expect_match(body, '{"model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":\\[178.95,0.5\\]},"xChannel":"FSC-A","type":"RangeGate","name":"my gate","gid":"[0-9A-Za-z]{24}","tailoredPerFile":false,"fcsFileId":null}', perl = TRUE) # nolint
      response <- httptest::fake_response(
        req$url,
        req$method,
        # Fixed GID, not the one passed in
        content = '{"__v":0,"experimentId":"591a3b441d725115208a6fda","model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":[178.95,0.5]},"gid":"592640a5a6a1d6256ec9b08a","xChannel":"FSC-A","type":"RangeGate","name":"my gate","_id":"592640aa298f1480900e10e4","tailoredPerFile":false,"fcsFileId":null}', # nolint
        status_code = 201,
        headers = list(`Content-Type` = "application/json")
      )
      return(response)
    },
    {
      setServer("https://my.server.com")
      resp <- createRangeGate("591a3b441d725115208a6fda", "FSC-A", "my gate",
        123.4, 234.5,
        createPopulation = FALSE
      )
      expect_equal(resp$gate$experimentId, "591a3b441d725115208a6fda")
      expect_equal(resp$gate$`_id`, "592640aa298f1480900e10e4") # assigned server-side
      expect_equal(resp$gate$xChannel, "FSC-A")
      expect_equal(resp$gate$name, "my gate")
      expect_equal(resp$gate$model$label, c(178.95, 0.5))
      expect_equal(resp$gate$model$range$x1, 123.4)
      expect_equal(resp$gate$model$range$x2, 234.5)
      expect_equal(resp$gate$model$range$y, 0.5)
      expect_equal(resp$gate$model$locked, FALSE)
      expect_equal(resp$gate$gid, "592640a5a6a1d6256ec9b08a")
      expect_equal(resp$gate$type, "RangeGate")
      expect_equal(resp$gate$tailoredPerFile, FALSE)
    }
  )
})

test_that("Correct HTTP request is made, fcsFileId specified", {
  with_mock(
    `httr::request_perform` = function(req, handle, refresh) {
      expect_equal(req$method, "POST")
      expect_equal(req$url, "https://my.server.com/api/v1/experiments/591a3b441d725115208a6fda/gates")
      body <- rawToChar(req$options$postfields)
      # Literal except for the gid value
      expect_match(body, '{"model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":\\[178.95,0.5\\]},"xChannel":"FSC-A","type":"RangeGate","name":"my gate","gid":"[0-9A-Za-z]{24}","tailoredPerFile":true,"fcsFileId":"591a3b441d725115208a6fdf"}', perl = TRUE) # nolint
      response <- httptest::fake_response(
        req$url,
        req$method,
        # Fixed GID, not the one passed in
        content = '{"__v":0,"experimentId":"591a3b441d725115208a6fda","model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":[178.95,0.5]},"gid":"592640a5a6a1d6256ec9b08a","xChannel":"FSC-A","type":"RangeGate","name":"my gate","_id":"592640aa298f1480900e10e4","tailoredPerFile":true,"fcsFileId":"591a3b441d725115208a6fdf"}', # nolint
        status_code = 201,
        headers = list(`Content-Type` = "application/json")
      )
      return(response)
    },
    {
      setServer("https://my.server.com")
      resp <- createRangeGate("591a3b441d725115208a6fda", "FSC-A", "my gate", 123.4, 234.5,
        tailoredPerFile = TRUE, fcsFileId = "591a3b441d725115208a6fdf", createPopulation = FALSE
      )
      expect_equal(resp$gate$experimentId, "591a3b441d725115208a6fda")
      expect_equal(resp$gate$`_id`, "592640aa298f1480900e10e4") # assigned server-side
      expect_equal(resp$gate$xChannel, "FSC-A")
      expect_equal(resp$gate$name, "my gate")
      expect_equal(resp$gate$model$label, c(178.95, 0.5))
      expect_equal(resp$gate$model$range$x1, 123.4)
      expect_equal(resp$gate$model$range$x2, 234.5)
      expect_equal(resp$gate$model$range$y, 0.5)
      expect_equal(resp$gate$model$locked, FALSE)
      expect_equal(resp$gate$gid, "592640a5a6a1d6256ec9b08a")
      expect_equal(resp$gate$type, "RangeGate")
      expect_equal(resp$gate$tailoredPerFile, TRUE)
      expect_equal(resp$gate$fcsFileId, "591a3b441d725115208a6fdf")
    }
  )
})

test_that("Correct HTTP request is made, createPopulation=TRUE, parentPopulationId=byName()", {
  with_mock(
    `httr::request_perform` = function(req, handle, refresh) {
      switch(req$url,
        "https://my.server.com/api/v1/experiments/591a3b441d725115208a6fda/populations?query=eq%28name%2C%20%22singlets%22%29&limit=2" = { # nolint
          expect_equal(req$method, "GET")
          response <- httptest::fake_response(
            req$url,
            req$method,
            content = '[
              {
                "_id":"591a3b5f1d725115208a7087","experimentId":"591a3b441d725115208a6fda","name":"singlets",
                "gates":"{\\"$and\\":[\\"591a3b5961a8a2302d15a33a\\"]}","parentId":null,
                "terminalGateGid":"591a3b5961a8a2302d15a33a","__v":0
              }
            ]',
            status_code = 200,
            headers = list(`Content-Type` = "application/json")
          )
        },
        "https://my.server.com/api/v1/experiments/591a3b441d725115208a6fda/gates?createPopulation=true&parentPopulationId=591a3b5f1d725115208a7087" = {
          expect_equal(req$method, "POST")
          body <- rawToChar(req$options$postfields)
          # Literal except for the gid value
          expect_match(body, '{"model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":\\[178.95,0.5\\]},"xChannel":"FSC-A","type":"RangeGate","name":"my gate","gid":"[0-9A-Za-z]{24}","tailoredPerFile":false,"fcsFileId":null}', perl = TRUE) # nolint
          response <- httptest::fake_response(
            req$url,
            req$method,
            # Fixed GID, not the one passed in
            content = '{
              "gate":{"__v":0,"experimentId":"591a3b441d725115208a6fda","model":{"locked":false,"range":{"x1":123.4,"x2":234.5,"y":0.5},"label":[178.95,0.5]},"gid":"592640a5a6a1d6256ec9b08a","xChannel":"FSC-A","type":"RangeGate","name":"my gate","_id":"592640aa298f1480900e10e4","tailoredPerFile":false},
              "population": {"parentId":null,"_id":"62fc44da8500a029b981e350","name":"my gate","gates":"{\\"$and\\":[\\"592640a5a6a1d6256ec9b08a\\"]}","terminalGateGid":"592640a5a6a1d6256ec9b08a","experimentId":"591a3b441d725115208a6fda"}
            }', # nolint
            status_code = 201,
            headers = list(`Content-Type` = "application/json")
          )
          return(response)
        },
        {
          stop(sprintf("Unexpected request URL: %s", req$url))
        }
      )
    },
    {
      setServer("https://my.server.com")
      resp <- createRangeGate("591a3b441d725115208a6fda", "FSC-A", "my gate",
        123.4, 234.5,
        parentPopulationId = byName("singlets"), createPopulation = TRUE
      )
      expect_equal(resp$gate$experimentId, "591a3b441d725115208a6fda")
      expect_equal(resp$gate$`_id`, "592640aa298f1480900e10e4") # assigned server-side
      expect_equal(resp$gate$xChannel, "FSC-A")
      expect_equal(resp$gate$name, "my gate")
      expect_equal(resp$gate$model$label, c(178.95, 0.5))
      expect_equal(resp$gate$model$range$x1, 123.4)
      expect_equal(resp$gate$model$range$x2, 234.5)
      expect_equal(resp$gate$model$range$y, 0.5)
      expect_equal(resp$gate$model$locked, FALSE)
      expect_equal(resp$gate$gid, "592640a5a6a1d6256ec9b08a")
      expect_equal(resp$gate$type, "RangeGate")
      expect_equal(resp$gate$tailoredPerFile, FALSE)
      expect_equal(resp$population$experimentId, "591a3b441d725115208a6fda")
      expect_equal(resp$population$parentId, NULL)
      expect_equal(resp$population$name, "my gate")
      expect_equal(resp$population$terminalGateGid, "592640a5a6a1d6256ec9b08a")
      expect_equal(resp$population$`_id`, "62fc44da8500a029b981e350")
    }
  )
})