Write history as part of layer metadata #877
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright 2018 Google LLC. All rights reserved. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.google.cloud.tools.jib.image; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonIgnore; | ||
| import com.fasterxml.jackson.annotation.JsonIgnoreProperties; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.google.cloud.tools.jib.json.JsonTemplate; | ||
| import java.util.Objects; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** Represents an item in the container configuration's {@code history} list. */ | ||
| @JsonIgnoreProperties(ignoreUnknown = true) | ||
| public class HistoryEntry implements JsonTemplate { | ||
|
There was a problem hiding this comment. I think this might better belong under the I'm thinking it might make more sense to call this There was a problem hiding this comment. I'll move it to the package, but I'm just going to make an issue for the second point for now. |
||
|
|
||
| /** The timestamp at which the image was created. */ | ||
|
There was a problem hiding this comment. A comment about this needing to be formatted according to RFC 3339, section 5.6 |
||
| private String created; | ||
|
There was a problem hiding this comment. Do we want to be making the There was a problem hiding this comment. I was referencing this and it didn't seem optional (no "omitempty"). There was a problem hiding this comment. Hmm, interesting - okay, let's match that behavior then since we don't want to break compatibility with Docker. There was a problem hiding this comment. But on the flip side we may error out reading an OCI-conformant image that has no There was a problem hiding this comment. Can name this in code style and use |
||
|
|
||
| /** The name of the author specified when committing the image. */ | ||
| @Nullable private String author; | ||
|
|
||
| /** The command used while building the image. */ | ||
|
There was a problem hiding this comment. s/while building/to build/? |
||
| @JsonProperty("created_by") | ||
| @Nullable | ||
| private String createdBy; | ||
|
|
||
| /** Whether or not the layer is empty ({@code @Nullable Boolean} to make field optional). */ | ||
|
There was a problem hiding this comment. This field is actually about whether or not this history entry corresponds to an actual layer in the container. |
||
| @JsonProperty("empty_layer") | ||
| @Nullable | ||
| private Boolean emptyLayer; | ||
|
There was a problem hiding this comment. Could be named like There was a problem hiding this comment. I think that naming is too different from the field it corresponds to and could get confusing. |
||
|
|
||
| public HistoryEntry() { | ||
| this("1970-01-01T00:00:00Z", null, null, null); | ||
| } | ||
|
|
||
| public HistoryEntry( | ||
| String created, | ||
| @Nullable String author, | ||
| @Nullable String createdBy, | ||
| @Nullable Boolean emptyLayer) { | ||
| this.author = author; | ||
| this.created = created; | ||
| this.createdBy = createdBy; | ||
| this.emptyLayer = emptyLayer; | ||
| } | ||
|
|
||
| /** | ||
| * Returns whether or not the history object corresponds to an empty layer. | ||
| * | ||
| * @return {@code true} if the history object corresponds to an empty layer | ||
| */ | ||
| @JsonIgnore | ||
| public boolean isEmptyLayer() { | ||
| return emptyLayer == null ? false : emptyLayer; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object other) { | ||
| if (this == other) { | ||
| return true; | ||
| } | ||
| if (other instanceof HistoryEntry) { | ||
| HistoryEntry otherHistory = (HistoryEntry) other; | ||
| return otherHistory.created.equals(created) | ||
| && Objects.equals(otherHistory.author, author) | ||
| && Objects.equals(otherHistory.createdBy, createdBy) | ||
| && Objects.equals(otherHistory.emptyLayer, emptyLayer); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(author, created, createdBy, emptyLayer); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add a link to https://github.com/opencontainers/image-spec/blob/master/config.md#properties and pointing specifically to the
historyfield.