github.com/pingcap/failpoint@v0.0.0-20240412033321-fd0796e60f86/code/restorer.go

// Copyright 2019 PingCAP, Inc.
//
// 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 code

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"strings"

	"github.com/sergi/go-diff/diffmatchpatch"
)

const (
	failpointStashFileSuffix = "__failpoint_stash__"
	failpointBindingFileName = "binding__failpoint_binding__.go"
)

// Restorer represents a manager to restore currentFile tree which has been modified by
// `failpoint-ctl enable`, e.g:
/*
// ├── foo
// │   ├── foo.go
// │   └── foo.go__failpoint_stash__
// ├── bar
// │   ├── bar.go
// │   └── bar.go__failpoint_stash__
// └── foobar
//     ├── foobar.go
//     └── foobar.go__failpoint_stash__
// Which will be restored as below:
// ├── foo
// │   └── foo.go <- foo.go__failpoint_stash__
// ├── bar
// │   └── bar.go <- bar.go__failpoint_stash__
// └── foobar
//     └── foobar.go <- foobar.go__failpoint_stash__
*/
type Restorer struct {
	path string
}

// NewRestorer returns a non-nil restorer which is used to clean the workspace
// of the specified path
func NewRestorer(path string) *Restorer {
	return &Restorer{path: path}
}

// Restore restores the currentFile tree which will delete all files generated
// by `failpoint-ctl enable` and replace it by fail point stashed currentFile
func (r Restorer) Restore() error {
	var stashFiles []string
	err := filepath.Walk(r.path, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}
		if info.IsDir() {
			return nil
		}
		if strings.HasSuffix(path, failpointStashFileSuffix) ||
			strings.HasSuffix(path, failpointBindingFileName) {
			stashFiles = append(stashFiles, path)
		}
		return nil
	})
	if err != nil {
		return err
	}
	for _, filePath := range stashFiles {
		if strings.HasSuffix(filePath, failpointBindingFileName) {
			if err := os.Remove(filePath); err != nil {
				return err
			}
			continue
		}
		originFileName := filePath[:len(filePath)-len(failpointStashFileSuffix)]
		rewritedContent, err := ioutil.ReadFile(originFileName)
		if err != nil {
			return err
		}
		originContent, err := ioutil.ReadFile(filePath)
		if err != nil {
			return err
		}
		// Rewrite original file
		rewriter := NewRewriter(filePath)
		buffer := &bytes.Buffer{}
		rewriter.SetOutput(buffer)
		if err := rewriter.RewriteFile(filePath); err != nil {
			return err
		}

		// Merge modifications after `failpoint-ctl enable`
		patcher := diffmatchpatch.New()
		diffs := patcher.DiffMain(buffer.String(), string(rewritedContent), true)
		patches := patcher.PatchMake(diffs)
		pathedContent, results := patcher.PatchApply(patches, string(originContent))
		for i, result := range results {
			if !result {
				return fmt.Errorf("cannot merge modifications back automatically %s", patches[i].String())
			}
		}
		if err := ioutil.WriteFile(filePath, []byte(pathedContent), 0644); err != nil {
			return err
		}
		if err := os.Remove(originFileName); err != nil {
			return err
		}
		if err := os.Rename(filePath, originFileName); err != nil {
			return err
		}
	}
	return nil
}

func failpointBindingPath(path string) string {
	return filepath.Join(filepath.Dir(path), failpointBindingFileName)
}

func isBindingFileExists(path string) (bool, error) {
	bindingFile := failpointBindingPath(path)
	_, err := os.Stat(bindingFile)
	if err != nil && os.IsNotExist(err) {
		return false, nil
	}
	return true, err
}

func writeBindingFile(path, pak string) error {
	bindingFile := failpointBindingPath(path)
	bindingContent := fmt.Sprintf(`
package %s

import "reflect"

type __failpointBindingType struct {pkgpath string}
var __failpointBindingCache = &__failpointBindingType{}

func init() {
	__failpointBindingCache.pkgpath = reflect.TypeOf(__failpointBindingType{}).PkgPath()
}
func %s(name string) string {
	return  __failpointBindingCache.pkgpath + "/" + name
}
`, pak, ExtendPkgName)
	return ioutil.WriteFile(bindingFile, []byte(bindingContent), 0644)
}