package image import ( "archive/tar" "encoding/json" "fmt" "github.com/docker/docker/client" "github.com/sirupsen/logrus" "github.com/wagoodman/dive/filetree" "github.com/wagoodman/dive/utils" "golang.org/x/net/context" "io" "io/ioutil" "strings" ) var dockerVersion string func newDockerImageAnalyzer(imageId string) Analyzer { return &dockerImageAnalyzer{ // store discovered json files in a map so we can read the image in one pass jsonFiles: make(map[string][]byte), layerMap: make(map[string]*filetree.FileTree), id: imageId, } } func newDockerImageManifest(manifestBytes []byte) dockerImageManifest { var manifest []dockerImageManifest err := json.Unmarshal(manifestBytes, &manifest) if err != nil { logrus.Panic(err) } return manifest[0] } func newDockerImageConfig(configBytes []byte) dockerImageConfig { var imageConfig dockerImageConfig err := json.Unmarshal(configBytes, &imageConfig) if err != nil { logrus.Panic(err) } layerIdx := 0 for idx := range imageConfig.History { if imageConfig.History[idx].EmptyLayer { imageConfig.History[idx].ID = "" } else { imageConfig.History[idx].ID = imageConfig.RootFs.DiffIds[layerIdx] layerIdx++ } } return imageConfig } func (image *dockerImageAnalyzer) Fetch() (io.ReadCloser, error) { var err error // pull the image if it does not exist ctx := context.Background() image.client, err = client.NewClientWithOpts(client.WithVersion(dockerVersion), client.FromEnv) if err != nil { return nil, err } _, _, err = image.client.ImageInspectWithRaw(ctx, image.id) if err != nil { // don't use the API, the CLI has more informative output fmt.Println("Image not available locally. Trying to pull '" + image.id + "'...") utils.RunDockerCmd("pull", image.id) } readCloser, err := image.client.ImageSave(ctx, []string{image.id}) if err != nil { return nil, err } return readCloser, nil } func (image *dockerImageAnalyzer) Parse(tarFile io.ReadCloser) error { tarReader := tar.NewReader(tarFile) var currentLayer uint for { header, err := tarReader.Next() if err == io.EOF { fmt.Println(" ╧") break } if err != nil { fmt.Println(err) utils.Exit(1) } name := header.Name // some layer tars can be relative layer symlinks to other layer tars if header.Typeflag == tar.TypeSymlink || header.Typeflag == tar.TypeReg { if strings.HasSuffix(name, "layer.tar") { currentLayer++ if err != nil { return err } layerReader := tar.NewReader(tarReader) err := image.processLayerTar(name, currentLayer, layerReader) if err != nil { return err } } else if strings.HasSuffix(name, ".json") { fileBuffer, err := ioutil.ReadAll(tarReader) if err != nil { return err } image.jsonFiles[name] = fileBuffer } } } return nil } func (image *dockerImageAnalyzer) Analyze() (*AnalysisResult, error) { image.trees = make([]*filetree.FileTree, 0) manifest := newDockerImageManifest(image.jsonFiles["manifest.json"]) config := newDockerImageConfig(image.jsonFiles[manifest.ConfigPath]) // build the content tree for _, treeName := range manifest.LayerTarPaths { image.trees = append(image.trees, image.layerMap[treeName]) } // build the layers array image.layers = make([]*dockerLayer, len(image.trees)) // note that the image config stores images in reverse chronological order, so iterate backwards through layers // as you iterate chronologically through history (ignoring history items that have no layer contents) layerIdx := len(image.trees) - 1 tarPathIdx := 0 for idx := 0; idx < len(config.History); idx++ { // ignore empty layers, we are only observing layers with content if config.History[idx].EmptyLayer { continue } tree := image.trees[(len(image.trees)-1)-layerIdx] config.History[idx].Size = uint64(tree.FileSize) image.layers[layerIdx] = &dockerLayer{ history: config.History[idx], index: layerIdx, tree: image.trees[layerIdx], tarPath: manifest.LayerTarPaths[tarPathIdx], } layerIdx-- tarPathIdx++ } efficiency, inefficiencies := filetree.Efficiency(image.trees) var sizeBytes, userSizeBytes uint64 layers := make([]Layer, len(image.layers)) for i, v := range image.layers { layers[i] = v sizeBytes += v.Size() if i != 0 { userSizeBytes += v.Size() } } var wastedBytes uint64 for idx := 0; idx < len(inefficiencies); idx++ { fileData := inefficiencies[len(inefficiencies)-1-idx] wastedBytes += uint64(fileData.CumulativeSize) } return &AnalysisResult{ Layers: layers, RefTrees: image.trees, Efficiency: efficiency, UserSizeByes: userSizeBytes, SizeBytes: sizeBytes, WastedBytes: wastedBytes, WastedUserPercent: float64(float64(wastedBytes) / float64(userSizeBytes)), Inefficiencies: inefficiencies, }, nil } // todo: it is bad that this is printing out to the screen. As the interface gets more flushed out, an event update mechanism should be built in (so the caller can format and print updates) func (image *dockerImageAnalyzer) processLayerTar(name string, layerIdx uint, reader *tar.Reader) error { tree := filetree.NewFileTree() tree.Name = name title := fmt.Sprintf("[layer: %2d]", layerIdx) message := fmt.Sprintf(" ├─ %s %s ", title, "working...") fmt.Printf("\r%s", message) fileInfos, err := image.getFileList(reader) if err != nil { return err } shortName := name[:15] pb := utils.NewProgressBar(int64(len(fileInfos)), 30) for idx, element := range fileInfos { tree.FileSize += uint64(element.Size) // todo: we should check for errors but also allow whiteout files to be not be added (thus not error out) tree.AddPath(element.Path, element) if pb.Update(int64(idx)) { message = fmt.Sprintf(" ├─ %s %s : %s", title, shortName, pb.String()) fmt.Printf("\r%s", message) } } pb.Done() message = fmt.Sprintf(" ├─ %s %s : %s", title, shortName, pb.String()) fmt.Printf("\r%s\n", message) image.layerMap[tree.Name] = tree return nil } func (image *dockerImageAnalyzer) getFileList(tarReader *tar.Reader) ([]filetree.FileInfo, error) { var files []filetree.FileInfo for { header, err := tarReader.Next() if err == io.EOF { break } else if err != nil { fmt.Println(err) utils.Exit(1) } name := header.Name switch header.Typeflag { case tar.TypeXGlobalHeader: return nil, fmt.Errorf("unexptected tar file: (XGlobalHeader): type=%v name=%s", header.Typeflag, name) case tar.TypeXHeader: return nil, fmt.Errorf("unexptected tar file (XHeader): type=%v name=%s", header.Typeflag, name) default: files = append(files, filetree.NewFileInfo(tarReader, header, name)) } } return files, nil }