Issues consolidations UX

README.md

@@ -39,7 +39,17 @@ Additional requirements for `build.sh`:
 
 ## Usage
 
-The `bap-builder` builds and stores all dependencies in the git repository (LFS enabled is recommended).
+The `packager` (`bap-builder`) has these commands:
+ - `build-image` for building Docker images
+ - `build-package` for building Packages
+ - `create-sysroot` for creating sysroot from already built Packages
+
+The `build-package` and `create-sysroot` commands are using Git Repository as storage for built
+Packages. Given Git Repository must be created before usage.
+
+**NOTE:** Detailed use case scenarios is decribed in [UseCaseScenarios](./doc/UseCaseScenarios.md) document.
+
+### Example
 
 1. Create a git repository (optionally with LFS):
 
@@ -49,19 +59,25 @@ The `bap-builder` builds and stores all dependencies in the git repository (LFS
     cd ../
     ```
 
-2. Build all Docker images needed for the build:
+2. Build Docker image needed for the build:
+
+    ```bash
+    bap-builder build-image --context ./example --name debian12
+    ```
+
+3. Build all Packages for the given distro:
 
     ```bash
-    bap-builder build-image --context ./example --name debian11
+    bap-builder build-package --context ./example --image-name debian12 --output-dir ./lfsrepo --all
     ```
 
-3. Build all packages for the given distro:
+4. Create sysroot for built Packages:
 
     ```bash
-    bap-builder build-package --context ./example --image-name debian11 --output-dir ./lfsrepo --all
+    bap-builder create-sysroot --context ./example --image-name debian12 --git-lfs ./lfsrepo --sysroot-dir ./new_sysroot
     ```
 
-*Note: If you do not have `bap-builder` in your system path, you need to use `./bap-builder/bap-builder` instead of `bap-builder`.*
+**Note:** If you do not have `bap-builder` in your system path, you need to use `./bap-builder/bap-builder` instead of `bap-builder`.
 
 ## Documentation
 

bap-builder/CmdArgs.go

@@ -29,6 +29,10 @@ type BuildPackageCmdLineArgs struct {
 	Name *string
 	// BuildDeps Build all dependencies of package when building single package
 	BuildDeps *bool
+	// BuildDepsOn Build package with all packages which depends on it
+	BuildDepsOn *bool
+	// BuildDepsOn Build package with all packages which depends on it recursively
+	BuildDepsOnRecursive *bool
 	// DockerImageName is a name of docker image to which packages will be build.
 	// If empty all docker images from DockerMatrix in config file are used for a given package.
 	// If not empty, only packages which contains DockerImageName in DockerMatrix will be built.
@@ -40,6 +44,17 @@ type BuildPackageCmdLineArgs struct {
 	OutputDirMode *OutputDirMode
 }
 
+// CreateSysrootCmdLineArgs
+// Options/setting for Sysroot mode
+type CreateSysrootCmdLineArgs struct {
+	// Path to the Git Lfs repository with packages
+	Repo *string
+	// Name of the new sysroot directory to be created
+	Sysroot *string
+	// Name of the docker image which are the packages build for
+	ImageName *string
+}
+
 // CmdLineArgs
 // Represents Cmd line arguments passed to  cmd line of the target program.
 // Program operates in two modes
@@ -54,11 +69,15 @@ type CmdLineArgs struct {
 	// Standard Cmd line arguments for Docker mode
 	BuildImagesArgs BuildImageCmdLineArgs
 	// If true the program is in the "Package" mode
-	BuildPackage       bool
-	BuildPackageArgs   BuildPackageCmdLineArgs
-	buildImageParser   *argparse.Command
-	buildPackageParser *argparse.Command
-	parser             *argparse.Parser
+	BuildPackage        bool
+	// If true the program is in the "Sysroot" mode
+	CreateSysroot       bool
+	BuildPackageArgs    BuildPackageCmdLineArgs
+	CreateSysrootArgs   CreateSysrootCmdLineArgs
+	buildImageParser    *argparse.Command
+	buildPackageParser  *argparse.Command
+	createSysrootParser *argparse.Command
+	parser              *argparse.Parser
 }
 
 // InitFlags
@@ -68,9 +87,8 @@ func (cmd *CmdLineArgs) InitFlags() {
 	cmd.parser = argparse.NewParser("BringAuto Packager", "Build and track C++ dependencies")
 	cmd.Context = cmd.parser.String("", "context",
 		&argparse.Options{
-			Required: false,
-			Default:  ".",
-			Help:     "Command context",
+			Required: true,
+			Help:     "Context directory where are the json definition of packages",
 		},
 	)
 
@@ -96,6 +114,22 @@ func (cmd *CmdLineArgs) InitFlags() {
 			Help:     "Build all dependencies of package when building single package",
 		},
 	)
+	cmd.BuildPackageArgs.BuildDepsOn = cmd.buildPackageParser.Flag("", "build-deps-on",
+		&argparse.Options{
+			Required: false,
+			Default:  false,
+			Help:     "Build packages which depends on given package without itself, " +
+			"the packages are built with its dependencies",
+		},
+	)
+	cmd.BuildPackageArgs.BuildDepsOnRecursive = cmd.buildPackageParser.Flag("", "build-deps-on-recursive",
+		&argparse.Options{
+			Required: false,
+			Default:  false,
+			Help:     "Build packages which depends on given package without itself recursively, " +
+			"the packages are built with its dependencies",
+		},
+	)
 	cmd.BuildPackageArgs.OutputDir = cmd.buildPackageParser.String("", "output-dir",
 		&argparse.Options{
 			Required: true,
@@ -104,11 +138,11 @@ func (cmd *CmdLineArgs) InitFlags() {
 	)
 	cmd.BuildPackageArgs.DockerImageName = cmd.buildPackageParser.String("", "image-name",
 		&argparse.Options{
-			Required: false,
-			Default:  "",
-			Help: "Docker image name for which packages will be build.\n" +
-				"Only packages that contains image-name in the DockerMatrix will be built.\n" +
-				"Given packages will be build by toolchain represented by image-name",
+			Required: true,
+			Validate: checkForEmpty,
+			Help: "Docker image name for which packages will be build. " +
+			"Only packages that contains image-name in the DockerMatrix will be built. " +
+			"Given packages will be build by toolchain represented by image-name",
 		},
 	)
 
@@ -126,6 +160,36 @@ func (cmd *CmdLineArgs) InitFlags() {
 			Help:     "Name of the docker image to build",
 		},
 	)
+
+	cmd.createSysrootParser = cmd.parser.NewCommand("create-sysroot", "Create Sysroot")
+	cmd.CreateSysrootArgs.Sysroot = cmd.createSysrootParser.String("", "sysroot-dir",
+		&argparse.Options{
+			Required: true,
+			Help:     "Name of the sysroot directory which will be created",
+		},
+	)
+	cmd.CreateSysrootArgs.Repo = cmd.createSysrootParser.String("", "git-lfs",
+		&argparse.Options{
+			Required: true,
+			Help:     "Git Lfs directory where packages are stored",
+		},
+	)
+	cmd.CreateSysrootArgs.ImageName = cmd.createSysrootParser.String("", "image-name",
+		&argparse.Options{
+			Required: true,
+			Validate: checkForEmpty,
+			Help:     "Name of docker image which are the packages built for",
+		},
+	)
+}
+
+func checkForEmpty(args []string) error {
+	if len(args) == 1 {
+		if len(args[0]) == 0 {
+			return fmt.Errorf("cannot be empty")
+		}
+	}
+	return nil
 }
 
 // ParseArgs
@@ -143,8 +207,22 @@ func (cmd *CmdLineArgs) ParseArgs(args []string) error {
 
 	cmd.BuildImage = cmd.buildImageParser.Happened()
 	cmd.BuildPackage = cmd.buildPackageParser.Happened()
-	if *cmd.BuildPackageArgs.All && *cmd.BuildPackageArgs.BuildDeps {
-		return fmt.Errorf("all and build-deps flags at the same time")
+	cmd.CreateSysroot = cmd.createSysrootParser.Happened()
+
+	if *cmd.BuildPackageArgs.All {
+		if *cmd.BuildPackageArgs.BuildDeps {
+			return fmt.Errorf("all and build-deps flags at the same time")
+		}
+		if *cmd.BuildPackageArgs.BuildDepsOn {
+			return fmt.Errorf("all and build-deps-on flags at the same time")
+		}
+		if *cmd.BuildPackageArgs.BuildDepsOnRecursive {
+			return fmt.Errorf("all and build-deps-on-recursive flags at the same time")
+		}
+	} else if *cmd.BuildPackageArgs.BuildDepsOn {
+		if *cmd.BuildPackageArgs.BuildDepsOnRecursive {
+			return fmt.Errorf("build-deps-on and build-deps-on-recursive flags at the same time")
+		}
 	}
 
 	return nil

bap-builder/DockerMode.go

@@ -3,14 +3,15 @@ package main
 import (
 	"bringauto/modules/bringauto_log"
 	"bringauto/modules/bringauto_docker"
+	"bringauto/modules/bringauto_context"
 	"path"
 )
 
 // BuildDockerImage
 // process Docker mode of cmd line
 //
 func BuildDockerImage(cmdLine *BuildImageCmdLineArgs, contextPath string) error {
-	contextManager := ContextManager{
+	contextManager := bringauto_context.ContextManager{
 		ContextPath: contextPath,
 	}
 	buildAll := cmdLine.All
@@ -29,7 +30,7 @@ func BuildDockerImage(cmdLine *BuildImageCmdLineArgs, contextPath string) error
 // builds all docker images in the given contextPath.
 // It returns nil if everything is ok, or not nil in case of error
 //
-func buildAllDockerImages(contextManager ContextManager) error {
+func buildAllDockerImages(contextManager bringauto_context.ContextManager) error {
 	dockerfilePathList, err := contextManager.GetAllImagesDockerfilePaths()
 	if err != nil {
 		return err