tools/check-licenses/project/init.go

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package project

import (
	"context"
	"encoding/json"
	"fmt"
	"io/fs"
	"path/filepath"

	"go.fuchsia.dev/fuchsia/tools/check-licenses/file"
	"go.fuchsia.dev/fuchsia/tools/check-licenses/project/readme"
	"go.fuchsia.dev/fuchsia/tools/check-licenses/util"
)

var (
	RootProject      *Project
	UnknownProject   *Project
	AllProjects      map[string]*Project
	FilteredProjects map[string]*Project

	DedupedLicenseData [][]*file.FileData

	git *util.Git
	ctx context.Context

	spdxIndex int
)

func init() {
	AllProjects = make(map[string]*Project, 0)
	FilteredProjects = make(map[string]*Project, 0)
	DedupedLicenseData = make([][]*file.FileData, 0)

	UnknownProject = &Project{
		Name:                   "unknown",
		LicenseFiles:           make([]*file.File, 0),
		RegularFiles:           make([]*file.File, 0),
		SearchableRegularFiles: make([]*file.File, 0),
		Children:               make(map[string]*Project, 0),
		ReadmeFile:             &readme.Readme{Licenses: make([]*readme.ReadmeLicense, 0)},
	}
}

func Initialize(c *ProjectConfig) error {
	var err error

	ctx = context.Background()
	git, err = util.NewGit()
	if err != nil {
		return err
	}

	// Save the config file to the out directory (if defined).
	if b, err := json.MarshalIndent(c, "", "  "); err != nil {
		return err
	} else {
		plusFile("_config.json", b)
	}

	Config = c
	return initializeCustomReadmes()
}

// Projects are created using README.fuchsia files.
// Many projects in the fuchsia tree do not have a README.fuchsia file,
// or they are incorrectly formatted.
//
// You can setup custom README.fuchsia files in a special directory,
// point to them in the config file, and they'll be parsed here
// before the rest of check-licenses executes.
func initializeCustomReadmes() error {
	for _, readmeCategory := range Config.Readmes {
		for _, readmePath := range readmeCategory.Paths {
			readmePath = filepath.Join(Config.FuchsiaDir, readmePath)
			if err := filepath.WalkDir(readmePath, func(currentPath string, info fs.DirEntry, err error) error {
				if err != nil {
					return err
				}

				if info.Name() == "README.fuchsia" ||
					info.Name() == "README.chromium" ||
					info.Name() == "README.crashpad" {
					plusVal(NumInitCustomProjects, currentPath)
					projectRoot := filepath.Dir(currentPath)
					projectRoot, err = filepath.Rel(readmePath, projectRoot)
					if err != nil {
						return err
					}

					r, err := readme.NewReadmeFromFileCustomLocation(projectRoot, currentPath)
					if err != nil {
						// Don't error out with these custom README.fuchsia files, so we don't break rollers.
						msg := fmt.Sprintf("Found issue with custom README.fuchsia file: %v: %v\n", currentPath, err)
						plusVal(ReadmeFileInitError, msg)

						return nil
					}

					if _, err := NewProject(r, projectRoot); err != nil {
						msg := fmt.Sprintf("Found issue with NON-custom README.fuchsia file: %v: %v\n", currentPath, err)
						plusVal(ReadmeFileInitError, msg)
						return nil
					}
				}
				return nil
			}); err != nil {
				return err
			}
		}
	}
	return nil
}