study-docker-repro-longevity/workflow/nickel/artifact_contract.ncl

100 lines
3.2 KiB
Plaintext

let
conf = {
ARCHIVE_FORMATS = ["zip", "tar"],
PACKAGE_MANAGERS = ["dpkg", "rpm", "pacman", "pip", "conda"],
VIRT_TECHS = ["docker"],
FILEPATH_REGEX = "^[^\\x00]+$", # For UNIX, anything of length > 0 but without NULL characters, found at: https://stackoverflow.com/questions/537772/what-is-the-most-correct-regular-expression-for-a-unix-file-path
URL_REGEX = "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$", # Found at: https://uibakery.io/regex-library/url
IMAGENAME_REGEX = "^[a-z0-9]+(([.]{0,1}|[_]{0,2}|[-]*)[a-z0-9]+)*(:[a-zA-Z0-9_]+[a-zA-Z0-9._-]*){0,1}$", # Based on, with modifications: https://regexr.com/3bsog
VERNUMBER_REGEX = "[0-9]+(\\.([0-9])+)*"
}
in
{
PackageManager = std.contract.from_predicate (
fun value => std.array.any (fun x => x == value) conf.PACKAGE_MANAGERS
),
ArchiveType = std.contract.from_predicate (
fun value => std.array.any (fun x => x == value) conf.ARCHIVE_FORMATS
),
FilePath = std.contract.from_predicate (
fun value => std.string.is_match conf.FILEPATH_REGEX value
),
URL = std.contract.from_predicate (
fun value => std.string.is_match conf.URL_REGEX value
),
VersionNumber = std.contract.from_predicate (
fun value => std.string.is_match conf.VERNUMBER_REGEX value
),
VirtTech = std.contract.from_predicate (
fun value => std.array.any (fun x => x == value) conf.VIRT_TECHS
),
GitPackage = {
name
| doc "Name of the package for future identification"
| String,
location
| doc "Path where cloned in the container"
| FilePath
},
MiscPackage = {
name
| doc "Name of the package for future identification"
| String,
url
| doc "URL of the package. Will be used to compute the hash"
| URL
},
PythonVenv = {
path
| doc "Path to the Python venv."
| FilePath
},
Artifact = {
version
| doc "Version of the Nickel contract"
| optional
| String
| default = "1.0",
artifact_url
| doc "URL where to download the artifact"
| URL,
type
| doc "Type of the archive. Possible values: zip, tar"
| ArchiveType,
doi
| doc "DOI of the artifact"
| String,
comment
| doc "Additional comments on the artifact that couldn't be written elsewhere"
| optional
| String
| default = "",
virtualization
| doc "Virtualization technology used in the artifact. Possible values: docker"
| VirtTech,
buildfile_dir
| doc "Path to the directory containing the file used to build the container in the artifact"
| FilePath,
package_managers
| doc "Package Managers used in the container. Possible values: dpkg, rpm, pacman, pip, conda"
| optional
| Array PackageManager
| default = [],
git_packages
| doc "Git repositories cloned in the container"
| optional
| Array GitPackage
| default = [],
misc_packages
| doc "Misc. packages downloaded from the container"
| optional
| Array MiscPackage
| default = [],
python_venvs
| doc "Python venvs created in the container"
| optional
| Array PythonVenv
| default = [],
}
}