Merge pull request #146 from daniel-sampliner/created-time

Allow setting the Created timestamp

cmd/image.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"runtime"
+	"time"
 
 	"github.com/nlewo/nix2container/nix"
 	"github.com/nlewo/nix2container/types"
@@ -15,12 +16,30 @@ import (
 
 var fromImageFilename string
 
+var created timeValue
+
+type timeValue time.Time
+
+func (tv *timeValue) String() string {
+	return (*time.Time)(tv).Format(time.RFC3339)
+}
+
+func (tv *timeValue) Set(value string) error {
+	t, err := time.Parse(time.RFC3339, value)
+	*tv = timeValue(t)
+	return err
+}
+
+func (tv *timeValue) Type() string {
+	return "time"
+}
+
 var imageCmd = &cobra.Command{
 	Use:   "image OUTPUT-FILENAME CONFIG.JSON LAYERS-1.JSON LAYERS-2.JSON ...",
 	Short: "Generate an image.json file from a image configuration and layers",
 	Args:  cobra.MinimumNArgs(3),
 	Run: func(cmd *cobra.Command, args []string) {
-		err := image(args[0], args[1], fromImageFilename, args[2:])
+		err := image(args[0], args[1], fromImageFilename, args[2:], (time.Time)(created))
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "%s", err)
 			os.Exit(1)
@@ -88,7 +107,7 @@ func imageFromManifest(outputFilename, manifestFilename string, blobsFilename st
 	return nil
 }
 
-func image(outputFilename, imageConfigPath string, fromImageFilename string, layerPaths []string) error {
+func image(outputFilename, imageConfigPath string, fromImageFilename string, layerPaths []string, created time.Time) error {
 	var imageConfig v1.ImageConfig
 	var image types.Image
 
@@ -117,6 +136,9 @@ func image(outputFilename, imageConfigPath string, fromImageFilename string, lay
 	image.Arch = runtime.GOARCH
 
 	image.ImageConfig = imageConfig
+
+	image.Created = &created
+
 	for _, path := range layerPaths {
 		var layers []types.Layer
 		layerJson, err := os.ReadFile(path)
@@ -145,6 +167,7 @@ func image(outputFilename, imageConfigPath string, fromImageFilename string, lay
 func init() {
 	rootCmd.AddCommand(imageCmd)
 	imageCmd.Flags().StringVarP(&fromImageFilename, "from-image", "", "", "A JSON file describing the base image")
+	imageCmd.Flags().Var(&created, "created", "Timestamp at which the image was created")
 	rootCmd.AddCommand(imageFromDirCmd)
 	rootCmd.AddCommand(imageFromManifestCmd)
 }

default.nix

@@ -391,6 +391,8 @@ let
     # controlled using nixUid/nixGid.
     nixUid ? 0,
     nixGid ? 0,
+    # Time of creation of the image.
+    created ? "0001-01-01T00:00:00Z",
     # Deprecated: will be removed
     contents ? null,
     meta ? {},
@@ -440,6 +442,7 @@ let
         layers = layers;
       };
       fromImageFlag = l.optionalString (fromImage != "") "--from-image ${fromImage}";
+      createdFlag = "--created ${created}";
       layerPaths = l.concatMapStringsSep " " (l: l + "/layers.json") (layers ++ [customizationLayer]);
       image = let
         imageName = l.toLower name;
@@ -467,6 +470,7 @@ let
         ${nix2container-bin}/bin/nix2container image \
         $out \
         ${fromImageFlag} \
+        ${createdFlag} \
         ${configFile} \
         ${layerPaths}
       '';

examples/created.nix

@@ -0,0 +1,8 @@
+{ pkgs, nix2container }:
+nix2container.buildImage {
+  name = "created";
+  config = {
+    entrypoint = ["${pkgs.hello}/bin/hello"];
+  };
+  created = "2024-05-13T09:31:10Z";
+}

examples/default.nix

@@ -14,4 +14,5 @@
   nix = pkgs.callPackage ./nix.nix { inherit nix2container; };
   nix-user = pkgs.callPackage ./nix-user.nix { inherit nix2container; };
   ownership = pkgs.callPackage ./ownership.nix { inherit nix2container; };
+  created = pkgs.callPackage ./created.nix { inherit nix2container; };
 }

nix/image.go

@@ -73,6 +73,7 @@ func getV1Image(image types.Image) (imageV1 v1.Image, err error) {
 	imageV1.OS = "linux"
 	imageV1.Architecture = image.Arch
 	imageV1.Config = image.ImageConfig
+	imageV1.Created = image.Created
 
 	for _, layer := range image.Layers {
 		digest, err := godigest.Parse(layer.DiffIDs)

tests/default.nix

@@ -137,6 +137,24 @@ let
       };
       pattern = "Hello, world!";
     };
+    created = let
+      image = examples.created;
+      timestamp = "2024-05-13 09:31:10";
+    in pkgs.writeScriptBin "test-script" ''
+      ${image.copyToPodman}/bin/copy-to-podman
+      created=$(${pkgs.podman}/bin/podman image inspect ${image.imageName}:${image.imageTag} -f '{{ .Created }}')
+      if echo $created | ${pkgs.gnugrep}/bin/grep '${timestamp}' > /dev/null;
+      then
+        echo "Test passed"
+      else
+        echo "Expected Created attribute to contain: ${timestamp}"
+        echo ""
+        echo "Actual Created attribute: $created"
+        echo ""
+        echo "Error: test failed"
+        exit $ret
+      fi
+    '';
   } //
   (pkgs.lib.mapAttrs' (name: drv: {
     name = "${name}GetManifest";

types/types.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"io"
 	"os"
+	"time"
 
 	v1 "github.com/opencontainers/image-spec/specs-go/v1"
 )
@@ -18,6 +19,7 @@ type Image struct {
 	ImageConfig v1.ImageConfig `json:"image-config"`
 	Layers      []Layer        `json:"layers"`
 	Arch        string         `json:"arch"`
+	Created     *time.Time     `json:"created"`
 }
 
 type Rewrite struct {