knit-report.R

#!/usr/bin/env Rscript

library(docopt)
library(rmarkdown)

arguments <- "
Generate a report of container image's infomation.

Usage:
  knit-report.R [-i <inspect_file>] [-m <manifest_file>] [-a <apt_file>] [-r <r_file>] [-p <pip_file>] <image_name> <output_dir>
  knit-report.R [-d <directory_name>] <image_name> <output_dir>

Options:
  -i --inspect    `docker instpect image` output file.
  -m --manifest   `docker buildx imagetools inspect` output file.
  -a --apt        `dpkg-query --show --showformat='${Package}\\t${Version}\\n'` output file.
  -r --R          `Rscript -e 'as.data.frame(installed.packages()[, 3])` output file.'
  -p --pip        `python3 -m pip list --disable-pip-version-check` output file.
  -d --directory  Directory, which contains source files, `docker_inspect.json`, `apt_packages.tsv`, `r_packages.ssv`, `pip_packages.ssv`.

Examples:
  ./build/knit-report.R -i docker_inspect.json -m imagetools_inspect.txt -a apt_packages.tsv -r r_packages.ssv -p pip_packages.ssv imageid reports
  ./build/knit-report.R -d tmp/imageid imageid reports
" |>
  docopt::docopt()

template <- "build/reports/template.Rmd"

image_name <- arguments$image_name
output_dir <- arguments$output_dir

inspect_file <- arguments$inspect_file
imagetotls_inspect_file <- arguments$manifest_file
apt_file <- arguments$apt_file
r_file <- arguments$r_file
pip_file <- arguments$pip_file

intermediates_dir <- NULL

if (arguments$directory == TRUE) {
  directory_name <- arguments$directory_name
  inspect_file <- paste0(directory_name, "/docker_inspect.json")
  imagetotls_inspect_file <- paste0(directory_name, "/imagetools_inspect.txt")
  apt_file <- paste0(directory_name, "/apt_packages.tsv")
  r_file <- paste0(directory_name, "/r_packages.ssv")
  pip_file <- paste0(directory_name, "/pip_packages.ssv")
  intermediates_dir <- directory_name
}

rmarkdown::render(
  input = template,
  intermediates_dir = intermediates_dir,
  output_dir = output_dir,
  output_file = paste0(arguments$image_name, ".md"),
  params = list(
    image_name = image_name,
    inspect_file = inspect_file,
    imagetotls_inspect_file = imagetotls_inspect_file,
    apt_file = apt_file,
    r_file = r_file,
    pip_file = pip_file
  )
)