-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #146 from zong-zhe/add-run-api
feat: create some APIs for command 'kpm run'.
- Loading branch information
Showing
14 changed files
with
211 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "kcl-lang.io/kpm/pkg/env" | ||
| "kcl-lang.io/kpm/pkg/errors" | ||
| "kcl-lang.io/kpm/pkg/oci" | ||
| "kcl-lang.io/kpm/pkg/opt" | ||
| pkg "kcl-lang.io/kpm/pkg/package" | ||
| "kcl-lang.io/kpm/pkg/reporter" | ||
| "kcl-lang.io/kpm/pkg/runner" | ||
| "kcl-lang.io/kpm/pkg/utils" | ||
| ) | ||
|
|
||
| // RunTar will compile the kcl package from a kcl package tar. | ||
| func RunTar(tarPath string, entryFiles []string, vendorMode bool, kclArgs string) (string, error) { | ||
| absTarPath, err := absTarPath(tarPath) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| // Extract the tar package to a directory with the same name. | ||
| // e.g. | ||
| // 'xxx/xxx/xxx/test.tar' will be extracted to the directory 'xxx/xxx/xxx/test'. | ||
| destDir := strings.TrimSuffix(absTarPath, filepath.Ext(absTarPath)) | ||
| err = utils.UnTarDir(absTarPath, destDir) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // The directory after extracting the tar package is taken as the root directory of the package, | ||
| // and kclvm is called to compile the kcl program under the 'destDir'. | ||
| // e.g. | ||
| // if the tar path is 'xxx/xxx/xxx/test.tar', | ||
| // the 'xxx/xxx/xxx/test' will be taken as the root path of the kcl package to compile. | ||
| compileResult, compileErr := RunPkgInPath(destDir, entryFiles, vendorMode, kclArgs) | ||
|
|
||
| if compileErr != nil { | ||
| return "", compileErr | ||
| } | ||
| return compileResult, nil | ||
| } | ||
|
|
||
| const KCL_PKG_TAR = "*.tar" | ||
|
|
||
| // RunOci will compile the kcl package from an OCI reference. | ||
| func RunOci(ociRef, version string, entryFiles []string, vendorMode bool, kclArgs string) (string, error) { | ||
| ociOpts, err := opt.ParseOciOptionFromString(ociRef, version) | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // 1. Create the temporary directory to pull the tar. | ||
| tmpDir, err := os.MkdirTemp("", "") | ||
| if err != nil { | ||
| return "", errors.InternalBug | ||
| } | ||
| // clean the temp dir. | ||
| defer os.RemoveAll(tmpDir) | ||
|
|
||
| localPath := ociOpts.AddStoragePathSuffix(tmpDir) | ||
|
|
||
| // 2. Pull the tar. | ||
| err = oci.Pull(localPath, ociOpts.Reg, ociOpts.Repo, ociOpts.Tag) | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // 3.Get the (*.tar) file path. | ||
| matches, err := filepath.Glob(filepath.Join(localPath, KCL_PKG_TAR)) | ||
| if err != nil || len(matches) != 1 { | ||
| return "", errors.FailedPull | ||
| } | ||
|
|
||
| return RunTar(matches[0], entryFiles, vendorMode, kclArgs) | ||
| } | ||
|
|
||
| // RunPkg will compile current kcl package. | ||
| func RunPkg(entryFiles []string, vendorMode bool, kclArgs string) (string, error) { | ||
|
|
||
| // If no tar packages specified by "--tar" to run | ||
| // kpm will take the current directory ($PWD) as the root of the kcl package and compile. | ||
| pwd, err := os.Getwd() | ||
|
|
||
| if err != nil { | ||
| reporter.ExitWithReport("kpm: internal bug: failed to load working directory") | ||
| } | ||
|
|
||
| compileResult, err := RunPkgInPath(pwd, entryFiles, vendorMode, kclArgs) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return compileResult, nil | ||
| } | ||
|
|
||
| // RunPkgInPath will load the 'KclPkg' from path 'pkgPath'. | ||
| // And run the kcl package with entry file in 'entryFilePath' in 'vendorMode'. | ||
| func RunPkgInPath(pkgPath string, entryFilePaths []string, vendorMode bool, kclArgs string) (string, error) { | ||
|
|
||
| pkgPath, err := filepath.Abs(pkgPath) | ||
| if err != nil { | ||
| return "", errors.InternalBug | ||
| } | ||
|
|
||
| kclPkg, err := pkg.LoadKclPkg(pkgPath) | ||
| if err != nil { | ||
| return "", errors.FailedToLoadPackage | ||
| } | ||
|
|
||
| kclPkg.SetVendorMode(vendorMode) | ||
|
|
||
| globalPkgPath, err := env.GetAbsPkgPath() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| err = kclPkg.ValidateKpmHome(globalPkgPath) | ||
| if err != (*reporter.KpmEvent)(nil) { | ||
| return "", err | ||
| } | ||
|
|
||
| // Calculate the absolute path of entry file described by '--input'. | ||
| compiler := runner.DefaultCompiler() | ||
| compiler.SetKclCliArgs(kclArgs) | ||
| for _, entryFilePath := range entryFilePaths { | ||
| entryFilePath, err = getAbsInputPath(pkgPath, entryFilePath) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| compiler.AddKFile(entryFilePath) | ||
| } | ||
|
|
||
| if len(entryFilePaths) == 0 && len(kclPkg.GetEntryKclFilesFromModFile()) == 0 { | ||
| compiler.AddKFile(kclPkg.HomePath) | ||
| } | ||
|
|
||
| // Call the kcl compiler. | ||
| compileResult, err := kclPkg.Compile( | ||
| globalPkgPath, | ||
| compiler, | ||
| ) | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return compileResult.GetRawYamlResult(), nil | ||
| } | ||
|
|
||
| // absTarPath checks whether path 'tarPath' exists and whether path 'tarPath' ends with '.tar' | ||
| // And after checking, absTarPath return the abs path for 'tarPath'. | ||
| func absTarPath(tarPath string) (string, error) { | ||
| absTarPath, err := filepath.Abs(tarPath) | ||
| if err != nil { | ||
| return "", errors.InternalBug | ||
| } | ||
|
|
||
| if filepath.Ext(absTarPath) != ".tar" { | ||
| return "", errors.InvalidKclPacakgeTar | ||
| } else if !utils.DirExists(absTarPath) { | ||
| return "", errors.KclPacakgeTarNotFound | ||
| } | ||
|
|
||
| return absTarPath, nil | ||
| } | ||
|
|
||
| // getAbsInputPath will return the abs path of the file path described by '--input'. | ||
| // If the path exists after 'inputPath' is computed as a full path, it will be returned. | ||
| // If not, the kpm checks whether the full path of 'pkgPath/inputPath' exists, | ||
| // If the full path of 'pkgPath/inputPath' exists, it will be returned. | ||
| // If not, getAbsInputPath returns 'entry file not found' error. | ||
| func getAbsInputPath(pkgPath string, inputPath string) (string, error) { | ||
| absPath, err := filepath.Abs(filepath.Join(pkgPath, inputPath)) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| if utils.DirExists(absPath) { | ||
| return absPath, nil | ||
| } | ||
|
|
||
| return "", errors.EntryFileNotFound | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.