Rdatatable · jangorecki · Dec 5, 2023 · Dec 5, 2023
@@ -1,72 +1,50 @@
 # data.table continuous integration and deployment
 
-On each Pull Request opened in GitHub we run Travis CI and Appveyor to provide prompt feedback about the status of PR. Our main CI pipeline runs on GitLab CI. GitLab repository automatically mirrors our GitHub repository and runs pipeline on `master` branch. It tests more environments and different configurations. It publish variety of artifacts.
+On each Pull Request opened in GitHub we run GitHub Actions test jobs to provide prompt feedback about the status of PR. Our main CI pipeline runs on GitLab CI nightly. GitLab repository automatically mirrors our GitHub repository and runs pipeline on `master` branch every night. It tests more environments and different configurations. It publish variety of artifacts.
 
 ## Environments
 
 ### [GitLab CI](./../.gitlab-ci.yml)
 
 Test jobs:
-- `test-rel-lin` - `r-release` on Linux, most comprehensive test environment, `-O3 -flto -fno-common -Wunused-result`, extra check for no compilation warnings, includes testing [_with other packages_](./../inst/tests/other.Rraw)
-- `test-rel-cran-lin` - `--as-cran` on Linux, `-g0`, extra check for final status of `R CMD check` where we allow one NOTE (_size of tarball_).
-- `test-dev-cran-lin` - `r-devel` and `--as-cran` on Linux, `--with-recommended-packages --enable-strict-barrier --disable-long-double`, tests for compilation warnings in pkg install and new NOTEs/Warnings in pkg check, and because it is R-devel it is marked as allow_failure
-- `test-rel-vanilla-lin` - `r-release` on Linux, no suggested deps, no OpenMP, `-O0`, tracks memory usage during tests
-- `test-310-cran-lin` - R 3.1.0 on Linux
-- `test-344-cran-lin` - R 3.4.4 on Linux
-- `test-350-cran-lin` - R 3.5.0 on Linux, no `r-recommended`
-- `test-rel-win` - `r-release` on Windows
-- `test-dev-win` - `r-devel` on Windows
-- `test-old-win` - `r-oldrel` on Windows
-- `test-rel-osx` - MacOSX build not yet deployed, see [#3326](https://github.com/Rdatatable/data.table/issues/3326) for status
+- `test-lin-rel` - `r-release` on Linux, most comprehensive test environment, force all suggests, `-O3 -flto=auto -fno-common -Wunused-result`, test for no compilation warnings.
+- `test-lin-rel-vanilla` - `r-release` on Linux, no suggested deps, no zlib, no OpenMP, flags `-g -O0 -fno-openmp`, skip manual and vignettes.
+- `test-lin-rel-cran` - `--as-cran` on Linux, strict test for final status of `R CMD check`.
+- `test-lin-dev-gcc-strict-cran` - `--as-cran` on Linux, `r-devel` built with `-enable-strict-barrier --disable-long-double`, test for compilation warnings, test for new NOTEs/WARNINGs from `R CMD check`.
+- `test-lin-dev-clang-cran` - same as `gcc-strict` job but R built with `clang` and  no `--enable-strict-barrier --disable-long-double` flags.
+- `test-lin-310-cran` - R 3.1.0 on Linux, stated R dependency version.
+- `test-win-rel` - `r-release` on Windows.
+- `test-win-dev` - `r-devel` on Windows.
+- `test-win-old` - `r-oldrel` on Windows.
+- `test-mac-rel` - macOS build not yet available, see [#3326](https://github.com/Rdatatable/data.table/issues/3326) for status
+
+Tests jobs are allowed to fail, summary and logs of test jobs are later published at _CRAN-like checks_ page, see artifacts below.
 
 Artifacts:
 - [homepage](https://rdatatable.gitlab.io/data.table) - made with [pkgdown](https://github.com/r-lib/pkgdown)
 - [html manual](https://rdatatable.gitlab.io/data.table/library/data.table/html/00Index.html)
 - [pdf manual](https://rdatatable.gitlab.io/data.table/web/packages/data.table/data.table.pdf)
 - [html vignettes](https://rdatatable.gitlab.io/data.table/library/data.table/doc/index.html)
-- R packages repository for `data.table` and all _Suggests_ dependencies, url: `https://Rdatatable.gitlab.io/data.table`
+- R packages repository for `data.table` and all _Suggests_ dependencies, url: `https://rdatatable.gitlab.io/data.table`
   - sources
   - Windows binaries for `r-release`, `r-devel` and `r-oldrel`
 - [CRAN-like homepage](https://rdatatable.gitlab.io/data.table/web/packages/data.table/index.html)
-- [CRAN-like checks results](https://rdatatable.gitlab.io/data.table/web/checks/check_results_data.table.html) - note that all artifacts, including check results page, are being published only when all test jobs successfully pass, thus one will not see an _ERROR_ status there (unless error happened on a job marked as `allow_failure`).
-- [docker images](https://gitlab.com/Rdatatable/data.table/container_registry) - copy/paste-able `docker pull` commands can be found at the bottom of our [CRAN-like homepage](https://rdatatable.gitlab.io/data.table/web/packages/data.table/index.html)
+- [CRAN-like checks results](https://rdatatable.gitlab.io/data.table/web/checks/check_results_data.table.html)
 
-### [Travis CI](./../.travis.yml)
+### [GitHub Actions](./../.github/workflows)
 
-Test jobs:
-- `r-release` on Linux, includes code coverage check
-- _(might be disabled)_ `r-release` on OSX
-
-Artifacts:
-- R packages repository having `data.table` sources only, url: `https://Rdatatable.github.io/data.table`
-- code coverage stats pushed to [codecov.io/gh/Rdatatable/data.table](https://codecov.io/gh/Rdatatable/data.table)
+TODO document
 
 ### [Appveyor](./../.appveyor.yml)
 
-Test jobs:
-- Windows `r-release`
-- _(might be disabled)_ Windows `r-devel`
-
-Artifacts:
-- Windows `r-release` binaries accessed only via web UI
+TODO document
 
-## Tools
+## CI tools
 
 ### [`ci.R`](./ci.R)
 
-Base R implemented helper script, [originally proposed to R](https://svn.r-project.org/R/branches/tools4pkgs/src/library/tools/R/packages.R), that ease the process of extracting dependency information from description files, also to mirror packages and their recursive dependencies from CRAN to local CRAN-like directory. It is widely used in our [GitLab CI pipeline](./../.gitlab-ci.yml).
+Base R implemented helper script, [originally proposed to base R](https://svn.r-project.org/R/branches/tools4pkgs/src/library/tools/R/packages.R), that ease the process of extracting dependency information from description files, and to mirror packages and their recursive dependencies from CRAN to local CRAN-like directory. It is used in [GitLab CI pipeline](./../.gitlab-ci.yml).
 
 ### [`publish.R`](./publish.R)
 
-Base R implemented helper script to orchestrate generation of most artifacts. It is being used only in [_integration_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
-
-### [`Dockerfile.in`](./Dockerfile.in)
-
-Template file to produce `Dockerfile` for, as of now, three docker images. Docker images are being built and published in [_deploy_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
-- `r-base-dev` using `r-release`: publish docker image of `data.table` on R-release
-- `r-builder` using `r-release`: publish on R-release and OS dependencies for building Rmarkdown vignettes
-- `r-devel`: publish docker image of `data.table` on R-devel built with `--with-recommended-packages --enable-strict-barrier --disable-long-double`
-
-### [`deploy.sh`](./deploy.sh)
-
-Script used on Travis CI to publish CRAN-like repository of `data.table` sources. It publishes to `gh-pages` branch in GitHub repository. It depends on a token, which is provided based on `secure` environment variable in [.travis.yml](./../.travis.yml). It has been generated by @jangorecki.
+Base R implemented helper script to orchestrate generation of most artifacts and to arrange them nicely. It is being used only in [_integration_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
@@ -91,16 +91,16 @@ package.index <- function(package, lib.loc, repodir="bus/integration/cran") {
   )
   vign = tools::getVignetteInfo(pkg, lib.loc=lib.loc)
   r_rel_ver = Sys.getenv("R_REL_VERSION")
-  r_devel_ver = Sys.getenv("R_DEVEL_VERSION")
-  r_oldrel_ver = Sys.getenv("R_OLDREL_VERSION")
-  stopifnot(nzchar(r_rel_ver), nzchar(r_devel_ver), nzchar(r_oldrel_ver))
+  r_dev_ver = Sys.getenv("R_DEV_VERSION")
+  r_old_ver = Sys.getenv("R_OLD_VERSION")
+  stopifnot(nzchar(r_rel_ver), nzchar(r_dev_ver), nzchar(r_old_ver))
   cran.home = "../../.."
   tbl.dl = c(
     sprintf("<tr><td> Reference manual: </td><td> <a href=\"%s.pdf\">%s.pdf</a>, <a href=\"%s/library/%s/html/00Index.html\">00Index.html</a> </td></tr>", pkg, pkg, cran.home, pkg),
     if (nrow(vign)) sprintf("<tr><td>Vignettes:</td><td>%s</td></tr>", paste(sprintf("<a href=\"%s/library/data.table/doc/%s\">%s</a><br/>", cran.home, vign[,"PDF"], vign[,"Title"]), collapse="\n")), # location unline cran web/pkg/vignettes to not duplicate content, documentation is in ../../../library
     sprintf("<tr><td> Package source: </td><td> <a href=\"%s/src/contrib/%s_%s.tar.gz\"> %s_%s.tar.gz </a> </td></tr>", cran.home,pkg, version, pkg, version),
-    sprintf("<tr><td> Windows binaries: </td><td> %s </td></tr>", format.bins(ver=c("r-devel","r-release","r-oldrel"), bin_ver=c(r_devel_ver, r_rel_ver, r_oldrel_ver), cran.home=cran.home, os.type="windows", pkg=pkg, version=version, repodir=repodir)),
-    sprintf("<tr><td> macOS binaries: </td><td> %s </td></tr>", format.bins(ver=c("r-release","r-oldrel"), bin_ver=c(r_rel_ver, r_oldrel_ver), cran.home=cran.home, os.type="macosx", pkg=pkg, version=version, repodir=repodir))
+    sprintf("<tr><td> Windows binaries: </td><td> %s </td></tr>", format.bins(ver=c("r-devel","r-release","r-oldrel"), bin_ver=c(r_dev_ver, r_rel_ver, r_old_ver), cran.home=cran.home, os.type="windows", pkg=pkg, version=version, repodir=repodir)),
+    sprintf("<tr><td> macOS binaries: </td><td> %s </td></tr>", format.bins(ver=c("r-release","r-oldrel"), bin_ver=c(r_rel_ver, r_old_ver), cran.home=cran.home, os.type="macosx", pkg=pkg, version=version, repodir=repodir))
   )
   index.file = file.path(repodir, "web/packages", pkg, "index.html")
   if (!dir.exists(dirname(index.file))) dir.create(dirname(index.file), recursive=TRUE)
@@ -155,24 +155,30 @@ plat <- function(x) if (grepl("^.*win", x)) "Windows" else if (grepl("^.*mac", x
 
 r.ver <- function(x) {
   tmp = strsplit(x, "-", fixed=TRUE)[[1L]]
-  if (length(tmp) < 2L) stop("test job names must be test-[r.version]-...")
-  v = tmp[2L]
+  if (length(tmp) < 3L) stop("test job names must be test-[lin|win|mac]-[r.version]-...")
+  v = tmp[3L]
   if (identical(v, "rel")) "r-release"
   else if (identical(v, "dev")) "r-devel"
   else if (identical(v, "old")) "r-oldrel"
   else {
-    if (grepl("\\D", v)) stop("second word in test job name must be rel/dev/old or numbers of R version")
+    if (grepl("\\D", v)) stop("third word in test job name must be rel/dev/old or numbers of R version")
     paste0("r-", paste(strsplit(v, "")[[1L]], collapse="."))
   }
 }
 
 # this for now is constant but when we move to independent pipelines (commit, daily, weekly) those values can be different
 pkg.version <- function(job, pkg) {
-  dcf = read.dcf(file.path("bus", job, paste(pkg, "Rcheck", sep="."), pkg, "DESCRIPTION"))
+  Rcheck = file.path("bus", job, paste(pkg, "Rcheck", sep="."))
+  if (!dir.exists(Rcheck))
+    return(NA_character_)
+  dcf = read.dcf(file.path(Rcheck, "00_pkg_src", pkg, "DESCRIPTION"))
   dcf[,"Version"]
 }
 pkg.revision <- function(job, pkg) {
-  dcf = read.dcf(file.path("bus", job, paste(pkg, "Rcheck", sep="."), pkg, "DESCRIPTION"))
+  Rcheck = file.path("bus", job, paste(pkg, "Rcheck", sep="."))
+  if (!dir.exists(Rcheck))
+    return(NA_character_)
+  dcf = read.dcf(file.path(Rcheck, "00_pkg_src", pkg, "DESCRIPTION"))
   if ("Revision" %in% colnames(dcf)) {
     proj.url = Sys.getenv("CI_PROJECT_URL", "")
     if (!nzchar(proj.url)) {
@@ -184,7 +190,10 @@ pkg.revision <- function(job, pkg) {
   } else ""
 }
 pkg.flags <- function(job, pkg) {
-  cc = file.path("bus", job, paste(pkg, "Rcheck", sep="."), pkg, "cc") ## data.table style cc file
+  Rcheck = file.path("bus", job, paste(pkg, "Rcheck", sep="."))
+  if (!dir.exists(Rcheck))
+    return(NA_character_)
+  cc = file.path(Rcheck, pkg, "cc") ## data.table style cc file
   if (file.exists(cc)) {
     d = readLines(cc)
     w.cflags = substr(d, 1, 7)=="CFLAGS="
@@ -254,6 +263,34 @@ check.flavors <- function(jobs, repodir="bus/integration/cran") {
   setNames(file.exists(file), file)
 }
 
+log.copy <- function(job, repodir="bus/integration/cran") {
+  dir.create(job.checks<-file.path(repodir, "web", "checks", pkg<-"data.table", job), recursive=TRUE, showWarnings=FALSE)
+  to = file.path(job.checks, "log")
+  if (!file.exists(job_id_file <- file.path("bus", job, "id")))
+    return(setNames(file.exists(to), "log"))
+  job_id = readLines(job_id_file, warn=FALSE)[1L]
+  from = sprintf("https://gitlab.com/Rdatatable/data.table/-/jobs/%s/raw", job_id)
+  download.file(from, to, method="wget", quiet=TRUE)
+  Sys.sleep(0.1) ## to not get ban from gitlab.com
+  setNames(file.exists(to), "log")
+}
+
+ci.status <- function(job) {
+  if (!file.exists(status_file <- file.path("bus", job, "status")))
+    return(NA_character_)
+  readLines(status_file, warn=FALSE)[1L]
+}
+
+ci.log <- function(jobs, repodir="bus/integration/cran") {
+  pkg = "data.table"
+  ans = vector("character", length(jobs))
+  logs = sapply(jobs, log.copy, repodir=repodir)
+  statuses = sapply(jobs, ci.status)
+  ans[!logs] = statuses[!logs]
+  ans[logs] = sprintf('<a href=\"%s/%s/log\">%s</a>', pkg[any(logs)], jobs[logs], statuses[logs])
+  ans
+}
+
 check.index <- function(pkg, jobs, repodir="bus/integration/cran") {
   status = function(x) if (grepl("^.*ERROR", x)) "ERROR" else if (grepl("^.*WARNING", x)) "WARNING" else if (grepl("^.*NOTE", x)) "NOTE" else if (grepl("^.*OK", x)) "OK" else NA_character_
   test.files = function(job, files, trim.name=FALSE, trim.exts=0L, pkg="data.table") {
@@ -294,17 +331,18 @@ check.index <- function(pkg, jobs, repodir="bus/integration/cran") {
     }
     memouts
   })
-  th = "<th>Flavor</th><th>Version</th><th>Revision</th><th>Install</th><th>Status</th><th>Flags</th><th>Rout.fail</th><th>Memtest</th>"
+  th = "<th>Flavor</th><th>Version</th><th>Revision</th><th>Install</th><th>Status</th><th>Flags</th><th>Rout.fail</th><th>Log</th><th>Memtest</th>"
   tbl = sprintf(
-    "<tr><td><a href=\"check_flavors.html\">%s</a></td><td>%s</td><td>%s</td><td><a href=\"%s/%s/00install.out\">out</a></td><td><a href=\"%s/%s/00check.log\">%s</a></td><td>%s</td><td>%s</td><td>%s</td></tr>",
-    sub("test-", "", jobs, fixed=TRUE),
-    sapply(jobs, pkg.version, pkg),
-    sapply(jobs, pkg.revision, pkg),
-    pkg, jobs, ## install
-    pkg, jobs, sapply(sapply(jobs, check.test, pkg="data.table"), status), ## check
-    sapply(jobs, pkg.flags, pkg),
-    mapply(test.files, jobs, routs, trim.exts=2L), # 1st fail, 2nd Rout, keep just: tests_x64/main
-    mapply(test.files, jobs, memouts, trim.name=TRUE)
+    "<tr><td><a href=\"check_flavors.html\">%s</a></td><td>%s</td><td>%s</td><td><a href=\"%s/%s/00install.out\">out</a></td><td><a href=\"%s/%s/00check.log\">%s</a></td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>",
+    sub("test-", "", jobs, fixed=TRUE), ## Flavor
+    sapply(jobs, pkg.version, pkg),     ## Version
+    sapply(jobs, pkg.revision, pkg),    ## Revision
+    pkg, jobs,                          ## Install
+    pkg, jobs, sapply(sapply(jobs, check.test, pkg="data.table"), status), ## Status
+    sapply(jobs, pkg.flags, pkg),                                          ## Flags
+    mapply(test.files, jobs, routs, trim.exts=2L),                         ## Rout.fail: 1st fail, 2nd Rout, keep just: tests_x64/main
+    ci.log(jobs),                                                          ## CI job logs
+    mapply(test.files, jobs, memouts, trim.name=TRUE)                      ## Memtest // currently not used
   )
   file = file.path(repodir, "web/checks", sprintf("check_results_%s.html", pkg))
   writeLines(c(
@@ -340,7 +378,7 @@ check.test <- function(job, pkg) {
   check[length(check)]
 }
 
-move.bin <- function(job, bin.version, os.type, file="DESCRIPTION", silent=FALSE) {
+move.bin <- function(job, bin.version, os.type, file="DESCRIPTION", silent=TRUE) {
   if (os.type=="unix") {
     stop("publish of linux binaries not supported")
   } else if (os.type=="windows") {