initial commit

Author: boshek

.Rbuildignore

@@ -0,0 +1,5 @@
+^LICENSE\.md$
+^.*\.Rproj$
+^\.Rproj\.user$
+^\.github$
+^\.conbench$

.gitignore

@@ -0,0 +1 @@
+.conbench

DESCRIPTION

@@ -0,0 +1,31 @@
+Package: conbenchcoms
+Title: An API wrapper for conbench communications
+Version: 0.0.1
+Authors@R: c(
+    person("Jonathan", "Keane", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0001-7087-9776")),
+    person("Sam", "Albers", , "[email protected]", role = c("aut", "ctb"),
+           comment = c(ORCID = "0000-0002-9270-7884")),
+    person("Edward", "Visel", , "[email protected]", role = c("aut", "ctb"),
+           comment = c(ORCID = "0000-0002-2811-6254")),
+    person(given = "Voltron Data",
+           role = c("cph", "fnd"))
+  )
+Description: An R interface to the conbench API.
+License: Apache License (>= 2)
+Depends: 
+    R (>= 4.1.0)
+Imports:
+    curl,
+    glue,
+    httr2,
+    utils,
+    yaml
+Suggests: 
+    httptest2,
+    testthat (>= 3.0.0),
+    withr
+Config/testthat/edition: 3
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.2.1

LICENSE.md

@@ -0,0 +1,194 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

NAMESPACE

@@ -0,0 +1,12 @@
+# Generated by roxygen2: do not edit by hand
+
+export(benchmarks)
+export(compare)
+export(conbench_perform)
+export(conbench_request)
+export(hardware)
+export(history)
+export(info)
+export(runs)
+export(url_cleaner)
+import(httr2)

R/benchmarks.R

@@ -0,0 +1,28 @@
+#' Get a list of benchmarks
+#'
+#' @param run_id the run_id to get benchmarks for (default: `NULL`, list all)
+#' @param batch_id the batch_id to get benchmarks for (default: `NULL`, list all)
+#' @inheritParams runs
+#'
+#' @return the response
+#' @export
+benchmarks <- function(run_id = NULL, batch_id = NULL, simplifyVector = TRUE, flatten = TRUE, ...) {
+  req <- req_url_path_append(conbench_request(), "benchmarks")
+
+  if (!is.null(batch_id)) {
+    req <- req_url_query(req, batch_id = paste0(batch_id, collapse = ","))
+    if (!utils::packageVersion("httr2") > "0.2.1") {
+      req$url <- curl::curl_unescape(req$url)
+    }
+  }
+
+  if (!is.null(run_id)) {
+    req <- req_url_query(req, run_id = paste0(run_id, collapse = ","))
+    if (!utils::packageVersion("httr2") > "0.2.1") {
+      req$url <- curl::curl_unescape(req$url)
+    }
+  }
+  resp <- conbench_perform(req)
+
+  resp_body_json(resp, simplifyVector = simplifyVector, flatten = flatten, ...)
+}

R/compare.R

@@ -0,0 +1,25 @@
+#' Compare runs, benchmarks, batches, or commits
+#'
+#' @param type the type of comparison to make (one of: runs, benchmarks, batches, commits)
+#' @param baseline the baseline sha of the entity to compare
+#' @param contender the contender sha of the entity to compare
+#' @inheritDotParams httr2::resp_body_json
+#'
+#' @return the JSON response
+#' @export
+compare <- function(type = c("runs", "benchmarks", "batches", "commits"),
+                    baseline,
+                    contender,
+                    ...) {
+  type <- match.arg(type)
+
+  req <- req_url_path_append(
+    conbench_request(),
+    "compare",
+    type,
+    paste0(baseline, "...", contender))
+
+  resp <- conbench_perform(req)
+
+  resp_body_json(resp, ...)
+}

R/conbench-request.R

@@ -0,0 +1,22 @@
+#' A wrapper around `request()` with Conbench URL
+#'
+#' Takes all the same arguments as `request()`. Should be used at the beginning
+#' of an `httr2` pipeline. By default, the conbench URL will be read from the
+#' .conbench file in the current working directory.
+#'
+#' @param base_url the base URL to use
+#'
+#' @return the request
+#' @export
+conbench_request <- function(base_url = NULL) {
+  if (is.null(base_url)) {
+    base_url <- tryCatch(
+      get_config()$url,
+      error = function(e) "https://conbench.ursa.dev"
+    )
+
+    base_url <- paste0(base_url, "/api")
+  }
+
+  request(base_url)
+}

R/conbenchcoms-package.R

@@ -0,0 +1,11 @@
+#' @keywords internal
+"_PACKAGE"
+
+# The following block is used by usethis to automatically manage
+# roxygen namespace tags. Modify with care!
+## usethis namespace: start
+## usethis namespace: end
+NULL
+
+#' @import httr2
+NULL

R/hardware.R

@@ -0,0 +1,18 @@
+#' Get hardware
+#'
+#' @param id the id of one specific hardware to get data for.
+#' @inheritParams runs
+#'
+#' @return the response
+#' @export
+hardware <- function(id = NULL, simplifyVector = TRUE, flatten = TRUE, ...) {
+  req <- req_url_path_append(conbench_request(), "hardware")
+
+  if (!is.null(id)) {
+    req <- req_url_path_append(req, id)
+  }
+
+  resp <- conbench_perform(req)
+
+  resp_body_json(resp, simplifyVector = simplifyVector, flatten = flatten, ...)
+}

R/history.R

@@ -0,0 +1,14 @@
+#' Get history for a benchmark
+#'
+#' @param benchmark_id the hash of a benchmark to get the history for
+#' @inheritParams runs
+#'
+#' @return the response
+#' @export
+history <- function(benchmark_id, simplifyVector = TRUE, flatten = TRUE, ...) {
+  req <- req_url_path_append(conbench_request(), "history", benchmark_id)
+
+  resp <- conbench_perform(req)
+
+  resp_body_json(resp, simplifyVector = simplifyVector, flatten = flatten, ...)
+}

R/info.R

@@ -0,0 +1,21 @@
+#' Get a list of benchmark info
+#'
+#' @param id the info id for benchmark info
+#' @inheritParams runs
+#'
+#' @return the response
+#' @export
+
+info <- function(id = NULL, simplifyVector = TRUE, flatten = TRUE, ...) {
+  req <- req_url_path_append(conbench_request(), "info")
+
+  if (!is.null(id)) {
+    req <- req_url_path_append(req, id)
+  }
+
+  resp <- conbench_perform(req)
+
+  resp_body_json(resp, simplifyVector = simplifyVector, flatten = flatten, ...)
+}
+
+