github.com/SAP/jenkins-library@v1.362.0/cmd/abapAddonAssemblyKitReleasePackages.go (about)

     1  package cmd
     2  
     3  import (
     4  	"encoding/json"
     5  	"time"
     6  
     7  	"github.com/SAP/jenkins-library/pkg/abap/aakaas"
     8  	abapbuild "github.com/SAP/jenkins-library/pkg/abap/build"
     9  	"github.com/SAP/jenkins-library/pkg/abaputils"
    10  	"github.com/SAP/jenkins-library/pkg/log"
    11  	"github.com/SAP/jenkins-library/pkg/telemetry"
    12  	"github.com/pkg/errors"
    13  )
    14  
    15  func abapAddonAssemblyKitReleasePackages(config abapAddonAssemblyKitReleasePackagesOptions, telemetryData *telemetry.CustomData, cpe *abapAddonAssemblyKitReleasePackagesCommonPipelineEnvironment) {
    16  	utils := aakaas.NewAakBundleWithTime(time.Duration(config.MaxRuntimeInMinutes), time.Duration(config.PollingIntervalInSeconds))
    17  
    18  	// error situations should stop execution through log.Entry().Fatal() call which leads to an os.Exit(1) in the end
    19  	if err := runAbapAddonAssemblyKitReleasePackages(&config, telemetryData, &utils, cpe); err != nil {
    20  		log.Entry().WithError(err).Fatal("step execution failed")
    21  	}
    22  }
    23  
    24  func runAbapAddonAssemblyKitReleasePackages(config *abapAddonAssemblyKitReleasePackagesOptions, telemetryData *telemetry.CustomData, utils *aakaas.AakUtils,
    25  	cpe *abapAddonAssemblyKitReleasePackagesCommonPipelineEnvironment) error {
    26  	conn := new(abapbuild.Connector)
    27  	if err := conn.InitAAKaaS(config.AbapAddonAssemblyKitEndpoint, config.Username, config.Password, *utils, config.AbapAddonAssemblyKitOriginHash, config.AbapAddonAssemblyKitCertificateFile, config.AbapAddonAssemblyKitCertificatePass); err != nil {
    28  		return err
    29  	}
    30  	var addonDescriptor abaputils.AddonDescriptor
    31  	if err := json.Unmarshal([]byte(config.AddonDescriptor), &addonDescriptor); err != nil {
    32  		return err
    33  	}
    34  
    35  	err := checkInput(addonDescriptor.Repositories)
    36  	if err != nil {
    37  		return err
    38  	}
    39  	packagesWithReposLocked, packagesWithReposNotLocked := sortByStatus(addonDescriptor.Repositories, *conn)
    40  	packagesWithReposLocked, err = releaseAndPoll(packagesWithReposLocked, utils)
    41  	if err != nil {
    42  		var numberOfReleasedPackages int
    43  		for i := range packagesWithReposLocked {
    44  			if packagesWithReposLocked[i].Package.Status == aakaas.PackageStatusReleased {
    45  				numberOfReleasedPackages += 1
    46  			}
    47  		}
    48  		if numberOfReleasedPackages == 0 {
    49  			return errors.Wrap(err, "Release of all packages failed/timed out - Aborting as abapEnvironmentAssembleConfirm step is not needed")
    50  		} else {
    51  			log.Entry().WithError(err).Warn("Release of at least one package failed/timed out - Continuing anyway to enable abapEnvironmentAssembleConfirm to run")
    52  		}
    53  	}
    54  	addonDescriptor.Repositories = sortingBack(packagesWithReposLocked, packagesWithReposNotLocked)
    55  	log.Entry().Info("Writing package status to CommonPipelineEnvironment")
    56  	cpe.abap.addonDescriptor = string(addonDescriptor.AsJSON())
    57  	return nil
    58  }
    59  
    60  func sortingBack(packagesWithReposLocked []aakaas.PackageWithRepository, packagesWithReposNotLocked []aakaas.PackageWithRepository) []abaputils.Repository {
    61  	var combinedRepos []abaputils.Repository
    62  	for i := range packagesWithReposLocked {
    63  		packagesWithReposLocked[i].Package.ChangeStatus(&packagesWithReposLocked[i].Repo)
    64  		combinedRepos = append(combinedRepos, packagesWithReposLocked[i].Repo)
    65  	}
    66  	for i := range packagesWithReposNotLocked {
    67  		combinedRepos = append(combinedRepos, packagesWithReposNotLocked[i].Repo)
    68  	}
    69  	return combinedRepos
    70  }
    71  
    72  func checkInput(repos []abaputils.Repository) error {
    73  	for i := range repos {
    74  		if repos[i].PackageName == "" {
    75  			return errors.New("Parameter missing. Please provide the name of the package which should be released")
    76  		}
    77  	}
    78  	return nil
    79  }
    80  
    81  func sortByStatus(repos []abaputils.Repository, conn abapbuild.Connector) ([]aakaas.PackageWithRepository, []aakaas.PackageWithRepository) {
    82  	var packagesWithReposLocked []aakaas.PackageWithRepository
    83  	var packagesWithReposNotLocked []aakaas.PackageWithRepository
    84  	for i := range repos {
    85  		var pack aakaas.Package
    86  		pack.InitPackage(repos[i], conn)
    87  		pWR := aakaas.PackageWithRepository{
    88  			Package: pack,
    89  			Repo:    repos[i],
    90  		}
    91  		if pack.Status == aakaas.PackageStatusLocked {
    92  			packagesWithReposLocked = append(packagesWithReposLocked, pWR)
    93  		} else {
    94  			log.Entry().Infof("Package %s has status %s, cannot release this package", pack.PackageName, pack.Status)
    95  			packagesWithReposNotLocked = append(packagesWithReposNotLocked, pWR)
    96  		}
    97  	}
    98  	return packagesWithReposLocked, packagesWithReposNotLocked
    99  }
   100  
   101  func releaseAndPoll(pckgWR []aakaas.PackageWithRepository, utils *aakaas.AakUtils) ([]aakaas.PackageWithRepository, error) {
   102  	timeout := time.After((*utils).GetMaxRuntime())
   103  	ticker := time.Tick((*utils).GetPollingInterval())
   104  
   105  	for {
   106  		select {
   107  		case <-timeout:
   108  			return pckgWR, errors.New("Timed out")
   109  		case <-ticker:
   110  			var allFinished bool = true
   111  			for i := range pckgWR {
   112  				if pckgWR[i].Package.Status != aakaas.PackageStatusReleased {
   113  					err := pckgWR[i].Package.Release()
   114  					// if there is an error, release is not yet finished
   115  					if err != nil {
   116  						log.Entry().Error(err)
   117  						log.Entry().Infof("Release of %s is not yet finished, check again in %s", pckgWR[i].Package.PackageName, (*utils).GetPollingInterval())
   118  						allFinished = false
   119  					}
   120  				}
   121  			}
   122  			if allFinished {
   123  				log.Entry().Infof("Release of package(s) was successful")
   124  				return pckgWR, nil
   125  			}
   126  		}
   127  	}
   128  }