2020-02-04 12:43:27 +02:00
package cmd
import (
"encoding/json"
2020-10-05 14:38:35 +02:00
"fmt"
2020-02-04 12:43:27 +02:00
"io/ioutil"
"net/http/cookiejar"
2020-04-08 12:43:41 +02:00
"reflect"
2020-02-04 12:43:27 +02:00
"time"
2020-07-23 10:26:50 +02:00
"github.com/SAP/jenkins-library/pkg/abaputils"
2020-02-04 12:43:27 +02:00
"github.com/SAP/jenkins-library/pkg/command"
piperhttp "github.com/SAP/jenkins-library/pkg/http"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/pkg/errors"
)
2021-08-04 17:31:16 +02:00
func abapEnvironmentPullGitRepo ( options abapEnvironmentPullGitRepoOptions , _ * telemetry . CustomData ) {
2020-07-31 14:43:23 +02:00
// for command execution use Command
c := command . Command { }
// reroute command output to logging framework
c . Stdout ( log . Writer ( ) )
c . Stderr ( log . Writer ( ) )
var autils = abaputils . AbapUtils {
Exec : & c ,
}
client := piperhttp . Client { }
// error situations should stop execution through log.Entry().Fatal() call which leads to an os.Exit(1) in the end
2021-08-04 17:31:16 +02:00
err := runAbapEnvironmentPullGitRepo ( & options , & autils , & client )
2020-07-31 14:43:23 +02:00
if err != nil {
log . Entry ( ) . WithError ( err ) . Fatal ( "step execution failed" )
}
}
2021-08-04 17:31:16 +02:00
func runAbapEnvironmentPullGitRepo ( options * abapEnvironmentPullGitRepoOptions , com abaputils . Communication , client piperhttp . Sender ) ( err error ) {
2020-07-23 10:26:50 +02:00
2020-11-02 15:17:13 +02:00
subOptions := convertPullConfig ( options )
2020-07-23 10:26:50 +02:00
2020-04-08 12:43:41 +02:00
// Determine the host, user and password, either via the input parameters or via a cloud foundry service key
2020-10-05 14:38:35 +02:00
connectionDetails , err := com . GetAbapCommunicationArrangementInfo ( subOptions , "/sap/opu/odata/sap/MANAGE_GIT_REPOSITORY/Pull" )
if err != nil {
return errors . Wrap ( err , "Parameters for the ABAP Connection not available" )
2020-02-04 12:43:27 +02:00
}
2020-10-05 14:38:35 +02:00
cookieJar , err := cookiejar . New ( nil )
if err != nil {
return errors . Wrap ( err , "Could not create a Cookie Jar" )
2020-04-08 12:43:41 +02:00
}
2020-02-04 12:43:27 +02:00
clientOptions := piperhttp . ClientOptions {
2020-05-28 13:08:26 +02:00
MaxRequestDuration : 180 * time . Second ,
2020-03-23 16:02:22 +02:00
CookieJar : cookieJar ,
Username : connectionDetails . User ,
Password : connectionDetails . Password ,
2020-02-04 12:43:27 +02:00
}
client . SetOptions ( clientOptions )
2020-08-07 11:09:58 +02:00
pollIntervall := com . GetPollIntervall ( )
2020-02-04 12:43:27 +02:00
2022-07-06 14:29:04 +02:00
var repositories [ ] abaputils . Repository
2020-10-05 14:38:35 +02:00
err = checkPullRepositoryConfiguration ( * options )
2021-12-20 18:58:58 +02:00
if err != nil {
return err
2020-10-05 14:38:35 +02:00
}
2022-06-28 11:02:15 +02:00
repositories , err = abaputils . GetRepositories ( & abaputils . RepositoriesConfig { RepositoryNames : options . RepositoryNames , Repositories : options . Repositories , RepositoryName : options . RepositoryName , CommitID : options . CommitID } , false )
2021-12-20 18:58:58 +02:00
handleIgnoreCommit ( repositories , options . IgnoreCommit )
2020-10-05 14:38:35 +02:00
if err != nil {
2021-12-20 18:58:58 +02:00
return err
2020-05-07 15:51:11 +02:00
}
2020-10-05 14:38:35 +02:00
2021-12-20 18:58:58 +02:00
err = pullRepositories ( repositories , connectionDetails , client , pollIntervall )
2020-10-05 14:38:35 +02:00
return err
2021-12-20 18:58:58 +02:00
2020-10-05 14:38:35 +02:00
}
func pullRepositories ( repositories [ ] abaputils . Repository , pullConnectionDetails abaputils . ConnectionDetailsHTTP , client piperhttp . Sender , pollIntervall time . Duration ) ( err error ) {
2020-11-02 15:17:13 +02:00
log . Entry ( ) . Infof ( "Start pulling %v repositories" , len ( repositories ) )
2020-10-05 14:38:35 +02:00
for _ , repo := range repositories {
err = handlePull ( repo , pullConnectionDetails , client , pollIntervall )
if err != nil {
break
}
2020-11-18 12:18:06 +02:00
}
if err == nil {
2020-10-05 14:38:35 +02:00
finishPullLogs ( )
}
return err
2020-02-04 12:43:27 +02:00
}
2020-11-02 15:17:13 +02:00
func handlePull ( repo abaputils . Repository , pullConnectionDetails abaputils . ConnectionDetailsHTTP , client piperhttp . Sender , pollIntervall time . Duration ) ( err error ) {
2021-12-20 18:58:58 +02:00
logString := repo . GetPullLogString ( )
errorString := "Pull of the " + logString + " failed on the ABAP system"
2020-11-02 15:17:13 +02:00
2021-12-20 18:58:58 +02:00
log . Entry ( ) . Info ( "-------------------------" )
log . Entry ( ) . Info ( "Start pulling the " + logString )
log . Entry ( ) . Info ( "-------------------------" )
2020-11-02 15:17:13 +02:00
uriConnectionDetails , err := triggerPull ( repo , pullConnectionDetails , client )
if err != nil {
2021-12-20 18:58:58 +02:00
return errors . Wrapf ( err , errorString )
2020-11-02 15:17:13 +02:00
}
// Polling the status of the repository import on the ABAP Environment system
status , errorPollEntity := abaputils . PollEntity ( repo . Name , uriConnectionDetails , client , pollIntervall )
if errorPollEntity != nil {
2021-12-20 18:58:58 +02:00
return errors . Wrapf ( errorPollEntity , errorString )
2020-11-02 15:17:13 +02:00
}
if status == "E" {
2021-12-20 18:58:58 +02:00
return errors . New ( errorString )
2020-11-02 15:17:13 +02:00
}
log . Entry ( ) . Info ( repo . Name + " was pulled successfully" )
return err
}
func triggerPull ( repo abaputils . Repository , pullConnectionDetails abaputils . ConnectionDetailsHTTP , client piperhttp . Sender ) ( abaputils . ConnectionDetailsHTTP , error ) {
2020-02-04 12:43:27 +02:00
uriConnectionDetails := pullConnectionDetails
uriConnectionDetails . URL = ""
pullConnectionDetails . XCsrfToken = "fetch"
// Loging into the ABAP System - getting the x-csrf-token and cookies
2020-08-04 17:52:28 +02:00
resp , err := abaputils . GetHTTPResponse ( "HEAD" , pullConnectionDetails , nil , client )
2020-02-04 12:43:27 +02:00
if err != nil {
2020-08-04 17:52:28 +02:00
err = abaputils . HandleHTTPError ( resp , err , "Authentication on the ABAP system failed" , pullConnectionDetails )
2020-02-04 12:43:27 +02:00
return uriConnectionDetails , err
}
2020-03-17 11:54:48 +02:00
defer resp . Body . Close ( )
2020-10-08 11:08:58 +02:00
2020-11-02 15:17:13 +02:00
log . Entry ( ) . WithField ( "StatusCode" , resp . Status ) . WithField ( "ABAP Endpoint" , pullConnectionDetails . URL ) . Debug ( "Authentication on the ABAP system successful" )
2020-02-04 12:43:27 +02:00
uriConnectionDetails . XCsrfToken = resp . Header . Get ( "X-Csrf-Token" )
pullConnectionDetails . XCsrfToken = uriConnectionDetails . XCsrfToken
// Trigger the Pull of a Repository
2020-11-02 15:17:13 +02:00
if repo . Name == "" {
2020-04-08 12:43:41 +02:00
return uriConnectionDetails , errors . New ( "An empty string was passed for the parameter 'repositoryName'" )
}
2021-12-20 18:58:58 +02:00
jsonBody := [ ] byte ( repo . GetPullRequestBody ( ) )
2020-08-04 17:52:28 +02:00
resp , err = abaputils . GetHTTPResponse ( "POST" , pullConnectionDetails , jsonBody , client )
2020-02-04 12:43:27 +02:00
if err != nil {
2021-12-20 18:58:58 +02:00
err = abaputils . HandleHTTPError ( resp , err , "Could not pull the " + repo . GetPullLogString ( ) , uriConnectionDetails )
2020-02-04 12:43:27 +02:00
return uriConnectionDetails , err
}
2020-03-17 11:54:48 +02:00
defer resp . Body . Close ( )
2021-12-20 18:58:58 +02:00
log . Entry ( ) . WithField ( "StatusCode" , resp . Status ) . WithField ( "repositoryName" , repo . Name ) . WithField ( "commitID" , repo . CommitID ) . WithField ( "Tag" , repo . Tag ) . Debug ( "Triggered Pull of repository / software component" )
2020-02-04 12:43:27 +02:00
// Parse Response
2020-07-23 10:26:50 +02:00
var body abaputils . PullEntity
2020-02-04 12:43:27 +02:00
var abapResp map [ string ] * json . RawMessage
2020-04-08 12:43:41 +02:00
bodyText , errRead := ioutil . ReadAll ( resp . Body )
if errRead != nil {
return uriConnectionDetails , err
}
2022-07-06 14:29:04 +02:00
if err := json . Unmarshal ( bodyText , & abapResp ) ; err != nil {
return uriConnectionDetails , err
}
if err := json . Unmarshal ( * abapResp [ "d" ] , & body ) ; err != nil {
return uriConnectionDetails , err
}
2020-07-23 10:26:50 +02:00
if reflect . DeepEqual ( abaputils . PullEntity { } , body ) {
2021-12-20 18:58:58 +02:00
log . Entry ( ) . WithField ( "StatusCode" , resp . Status ) . WithField ( "repositoryName" , repo . Name ) . WithField ( "commitID" , repo . CommitID ) . WithField ( "Tag" , repo . Tag ) . Error ( "Could not pull the repository / software component" )
2020-04-08 12:43:41 +02:00
err := errors . New ( "Request to ABAP System not successful" )
2020-02-04 12:43:27 +02:00
return uriConnectionDetails , err
}
2020-04-08 12:43:41 +02:00
2022-02-11 11:16:40 +02:00
uriConnectionDetails . URL = body . Metadata . URI
2020-02-04 12:43:27 +02:00
return uriConnectionDetails , nil
}
2020-10-05 14:38:35 +02:00
func checkPullRepositoryConfiguration ( options abapEnvironmentPullGitRepoOptions ) error {
2022-06-28 11:02:15 +02:00
if ( len ( options . RepositoryNames ) > 0 && options . Repositories != "" ) || ( len ( options . RepositoryNames ) > 0 && options . RepositoryName != "" ) || ( options . RepositoryName != "" && options . Repositories != "" ) {
return fmt . Errorf ( "Checking configuration failed: %w" , errors . New ( "Only one of the paramters `RepositoryName`,`RepositoryNames` or `Repositories` may be configured at the same time" ) )
2020-10-05 14:38:35 +02:00
}
2022-06-28 11:02:15 +02:00
if len ( options . RepositoryNames ) == 0 && options . Repositories == "" && options . RepositoryName == "" {
2020-10-05 14:38:35 +02:00
return fmt . Errorf ( "Checking configuration failed: %w" , errors . New ( "You have not specified any repository configuration to be pulled into the ABAP Environment System. Please make sure that you specified the repositories that should be pulled either in a dedicated file or via the parameter 'repositoryNames'. For more information please read the User documentation" ) )
}
return nil
}
func finishPullLogs ( ) {
log . Entry ( ) . Info ( "-------------------------" )
log . Entry ( ) . Info ( "All repositories were pulled successfully" )
}
2020-11-02 15:17:13 +02:00
func convertPullConfig ( config * abapEnvironmentPullGitRepoOptions ) abaputils . AbapEnvironmentOptions {
subOptions := abaputils . AbapEnvironmentOptions { }
subOptions . CfAPIEndpoint = config . CfAPIEndpoint
subOptions . CfServiceInstance = config . CfServiceInstance
subOptions . CfServiceKeyName = config . CfServiceKeyName
subOptions . CfOrg = config . CfOrg
subOptions . CfSpace = config . CfSpace
subOptions . Host = config . Host
subOptions . Password = config . Password
subOptions . Username = config . Username
return subOptions
}
func handleIgnoreCommit ( repositories [ ] abaputils . Repository , ignoreCommit bool ) {
for i := range repositories {
if ignoreCommit {
repositories [ i ] . CommitID = ""
}
}
}