Test osm_diff_upload_changeset()

ropensci · Apr 26, 2024 · 91a6ddb · 91a6ddb
1 parent 124d163
commit 91a6ddb
Show file tree

Hide file tree

Showing 13 changed files with 102 additions and 40 deletions.
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -84,6 +84,7 @@ diffResult
 dir
 discussionL
 displayname
+doesnt
 doi
 dontrun
 doTrace

diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/268845.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/268845.xml
diff --git a/...g/api/0.6/changeset/268845-027b21-PUT.xml → ...g/api/0.6/changeset/357556-027b21-PUT.xml b/...g/api/0.6/changeset/268845-027b21-PUT.xml → ...g/api/0.6/changeset/357556-027b21-PUT.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <osm version="0.6" generator="OpenStreetMap server" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
-<changeset id="268845" created_at="2023-08-18T16:28:07Z" open="true" comments_count="0" changes_count="0" uid="12141" user="jmaspons">
+<changeset id="357556" created_at="2024-04-26T16:12:00Z" open="true" comments_count="0" changes_count="0" uid="12141" user="jmaspons">
   <tag k="comment" v="Improved description of the changeset"/>
   <tag k="created_by" v="osmapiR"/>
   <tag k="hashtags" v="#testing;#osmapiR"/>

diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<osm version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <changeset id="357556" created_at="2024-04-26T16:12:00Z" open="true" user="jmaspons" uid="12141" comments_count="0" changes_count="0">
+  <tag k="comment" v="Describe the changeset"/>
+  <tag k="created_by" v="osmapiR"/>
+  <tag k="hashtags" v="#testing;#osmapiR"/>
+  <tag k="source" v="GPS;survey"/>
+ </changeset>
+</osm>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/close-PUT.html b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/close-PUT.html
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-6da605-POST.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-6da605-POST.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<diffResult version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <node old_id="4348975165"/>
+ <node old_id="4348975166"/>
+</diffResult>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-a53d2f-POST.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-a53d2f-POST.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<diffResult version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <node old_id="-1" new_id="4348975165" new_version="1"/>
+ <node old_id="-2" new_id="4348975166" new_version="1"/>
+ <way old_id="-3" new_id="4306500964" new_version="1"/>
+ <relation old_id="-4" new_id="4305223445" new_version="1"/>
+</diffResult>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-a640e6-POST.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/357556/upload-a640e6-POST.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<diffResult version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <relation old_id="4305223445"/>
+ <way old_id="4306500964"/>
+</diffResult>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/create-3af8d1-PUT.txt b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/changeset/create-3af8d1-PUT.txt
@@ -1 +1 @@
-268845
+357556
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/nodes-079ea3.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/nodes-079ea3.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<osm version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <node id="4348975165" visible="true" version="1" changeset="357556" timestamp="2024-04-26T16:12:00Z" user="jmaspons" uid="12141" lat="0.0000000" lon="0.0000000"/>
+ <node id="4348975166" visible="true" version="1" changeset="357556" timestamp="2024-04-26T16:12:00Z" user="jmaspons" uid="12141" lat="1.0000000" lon="1.0000000"/>
+</osm>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/relations-6c7cee.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/relations-6c7cee.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<osm version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <relation id="4305223445" visible="true" version="1" changeset="357556" timestamp="2024-04-26T16:12:00Z" user="jmaspons" uid="12141">
+  <member type="node" ref="4348975165" role="NA"/>
+  <member type="node" ref="4348975166" role="NA"/>
+  <member type="way" ref="4306500964" role="outer"/>
+  <tag k="name" v="Our relation"/>
+  <tag k="type" v="Column clash!"/>
+ </relation>
+</osm>
diff --git a/tests/testthat/mock_edit_changeset/osm.org/api/0.6/ways-60ab28.xml b/tests/testthat/mock_edit_changeset/osm.org/api/0.6/ways-60ab28.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<osm version="0.6" generator="CGImap 0.10.0.2404251208 (012345 ******.openstreetmap.org)" copyright="OpenStreetMap and contributors" attribution="http://www.openstreetmap.org/copyright" license="http://opendatacommons.org/licenses/odbl/1-0/">
+ <way id="4306500964" visible="true" version="1" changeset="357556" timestamp="2024-04-26T16:12:00Z" user="jmaspons" uid="12141">
+  <nd ref="4348975165"/>
+  <nd ref="4348975166"/>
+  <tag k="name" v="My way"/>
+ </way>
+</osm>
diff --git a/tests/testthat/test-changesets.R b/tests/testthat/test-changesets.R
@@ -27,6 +27,24 @@ class_columns_discussion <- list(
 
 
 test_that("edit changeset (create/update/diff upload) works", {
+  d <- data.frame(
+    type = c("node", "node", "way", "relation"),
+    id = -(1:4),
+    lat = c(0, 1, NA, NA),
+    lon = c(0, 1, NA, NA),
+    name = c(NA, NA, "My way", "Our relation"),
+    type.1 = c(NA, NA, NA, "Column clash!")
+  )
+  d$members <- list(
+    NULL, NULL, -(1:2),
+    matrix(
+      c("node", "-1", NA, "node", "-2", NA, "way", "-3", "outer"),
+      nrow = 3, ncol = 3, byrow = TRUE, dimnames = list(NULL, c("type", "ref", "role"))
+    )
+  )
+  obj <- osmapi_objects(d, tag_columns = c(name = "name", type = "type.1"))
+  osmchange_crea <- osmchange_create(obj)
+
   with_mock_dir("mock_edit_changeset", {
     ## Create: `PUT /api/0.6/changeset/create` ----
     expect_message(
@@ -49,44 +67,47 @@ test_that("edit changeset (create/update/diff upload) works", {
       created_by = "osmapiR", # avoid changes in calls when updating version
       hashtags = "#testing;#osmapiR"
     )
+
+    ## Diff upload: `POST /api/0.6/changeset/#id/upload` ----
+    diff_up <- osm_diff_upload_changeset(changeset_id = chset_id, osmcha = osmchange_crea)
+
+    osmchange_del <- osmchange_delete(data.frame(type = diff_up$type, id = diff_up$new_id))
+    osmchange_del_xml <- osmcha_DF2xml(osmchange_del[osmchange_del$type != "node", ])
+    osmchange_del_file <- osmcha_DF2xml(osmchange_del[osmchange_del$type == "node", ])
+    path_del <- tempfile(fileext = ".osc")
+    xml2::write_xml(osmchange_del_file, path_del)
+    diff_up_del1 <- osm_diff_upload_changeset(changeset_id = chset_id, osmcha = osmchange_del_xml, format = "xml")
+    diff_up_del2 <- osm_diff_upload_changeset(changeset_id = chset_id, osmcha = path_del)
+
+    ## Close: `PUT /api/0.6/changeset/#id/close` ----
+    resp_close <- osm_close_changeset(changeset_id = chset_id)
   })
+  file.remove(path_del)
 
   expect_type(chset_id, "character")
-  expect_s3_class(upd_chaset, c("osmapi_changesets", "data.frame"))
+  expect_s3_class(upd_chaset, c("osmapi_changesets", "data.frame"), exact = TRUE)
   expect_identical(chaset[, setdiff(names(chaset), "tags")], upd_chaset[, setdiff(names(upd_chaset), "tags")])
 
   expect_error(osm_create_changeset(), "A descriptive comment of the changeset is mandatory.")
   expect_error(osm_update_changeset(), "A descriptive comment of the changeset is mandatory.")
 
-  ## Diff upload: `POST /api/0.6/changeset/#id/upload` ----
-
-  xml <- xml2::read_xml(test_path("sample_files/osm_objects.xml"))
-  objs <- object_xml2DF(xml)
-  osm_change <- cbind(action_type = c("delete", "modify", "delete", "modify", "modify"), objs)
-  class(osm_change) <- c("osmapi_OsmChange", class(osm_change))
-
-  osm_change$tags[osm_change$action_type == "modify"] <- lapply(
-    osm_change$tags[osm_change$action_type == "modify"],
-    function(x) rbind(x, c("name:ca", "Test modify with OsmChange"))
+  expect_s3_class(diff_up, "data.frame")
+  expect_s3_class(diff_up_del1, "xml_document")
+  expect_s3_class(diff_up_del2, "data.frame")
+  expect_named(diff_up, c("type", "old_id", "new_id", "new_version"))
+  expect_named(diff_up_del2, c("type", "old_id"))
+  expect_equal(nrow(diff_up), nrow(obj))
+  expect_equal(length(xml2::xml_children(diff_up_del1)) + nrow(diff_up_del2), nrow(obj))
+
+  expect_error(
+    osm_diff_upload_changeset(changeset_id = chset_id, osmcha = numeric()),
+    "`osmcha` must be a path to a OsmChage file, a `xml_document` with a OsmChange content or an `osmapi_OsmChange` "
   )
-
-  osm_change_xml <- osmcha_DF2xml(osm_change)
-
-  with_mock_dir("mock_diff_up_changeset", {
-    # TODO: better testing for osm_diff_upload_changeset
-    # fetch <- list()
-    # fetch$node <- osm_fetch_objects(osm_type = "nodes", osm_ids = c(35308286, 1935675367))
-    # fetch$way <- osm_fetch_objects(osm_type = "ways", osm_ids = c(13073736L, 235744929L))
-    # fetch$rel <- osm_fetch_objects(osm_type = "relations", osm_ids = c("40581", "341530"))
-    # HTTP 404 Not Found. (testing server)
-    # bbox_objects <- osm_bbox_objects(bbox = c(0.5, 40, 1, 40.5))
-
-    # diff_up <-  osm_diff_upload_changeset(changeset_id = chset_id, osmcha = osm_change)
-    # TODO: ! HTTP 409 Conflict. In testing server
-  })
-
-  ## Close: `PUT /api/0.6/changeset/#id/close` ----
-  # osm_close_changeset(changeset_id = chset_id)
+  expect_error(
+    osm_diff_upload_changeset(changeset_id = chset_id, osmcha = "doesnt_exist"),
+    "`osmcha` is interpreted as a path to an OsmChange file, but it can't be found "
+  )
+  expect_null(resp_close)
 })