codeql/go/extractor/util/overlays.go

package util

import (
	"encoding/json"
	"log"
	"os"
	"path/filepath"
)

func IsOverlayExtraction() bool {
	_, present := os.LookupEnv("CODEQL_EXTRACTOR_GO_OVERLAY_METADATA_IN")
	return present
}

// If the relevant environment variable is set, indicating that we are extracting an overlay
// database, GetOverlayChanges returns the list of relative paths of files that have changed (or
// been deleted). Otherwise, it returns `nil`.
func GetOverlayChanges(sourceRoot string) []string {
	if overlayChangesJsonPath, present := os.LookupEnv("CODEQL_EXTRACTOR_GO_OVERLAY_CHANGES"); present {
		log.Printf("Reading overlay changes from: %s", overlayChangesJsonPath)

		file, err := os.Open(overlayChangesJsonPath)
		if err != nil {
			log.Fatalf("Failed to open overlay changes JSON file: %s", err)
		}
		defer file.Close()

		var overlayData struct {
			Changes []string `json:"changes"`
		}

		decoder := json.NewDecoder(file)
		if err := decoder.Decode(&overlayData); err != nil {
			log.Fatalf("Failed to decode overlay changes JSON file: %s", err)
		}

		absPaths := make([]string, 0, len(overlayData.Changes))
		if sourceRoot == "" {
			// This shouldn't happen, because it implies the extractor was invoked in some way other
			// than from the autobuilder. However, we'll only attempt to build an overlay if there
			// exists an overlay _base_, and only the autobuilder writes the metadata file that
			// ensures a database is created as an overlay-base.
			log.Fatalf("Extractor is running in overlay mode, but --source-root was not provided")
		}
		for _, relPath := range overlayData.Changes {
			absPaths = append(absPaths, filepath.Clean(sourceRoot+"/"+relPath))
		}

		return absPaths
	} else {
		return nil
	}
}

// WriteOverlayBaseMetadata creates an empty metadata file if we are extracting an overlay base;
// otherwise, it does nothing.
func WriteOverlayBaseMetadata() {
	if metadataPath, present := os.LookupEnv("CODEQL_EXTRACTOR_GO_OVERLAY_BASE_METADATA_OUT"); present {
		log.Printf("Writing overlay base metadata to: %s", metadataPath)

		// In principle, we could store some metadata here and read it back when extracting the
		// overlay. For now, we don't need to store anything, but the CLI still requires us to write
		// something, so just create an empty file.
		file, err := os.Create(metadataPath)
		if err != nil {
			log.Fatalf("Failed to create overlay base metadata file: %s", err)
		}
		file.Close()
	}
}