2020-02-19 20:26:47 +02:00
|
|
|
package http
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/http"
|
|
|
|
"os"
|
2020-02-25 17:52:12 +02:00
|
|
|
"path/filepath"
|
2022-06-29 12:00:37 +02:00
|
|
|
"strings"
|
2021-06-23 14:41:52 +02:00
|
|
|
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
|
|
|
|
"github.com/SAP/jenkins-library/pkg/piperutils"
|
2020-02-19 20:26:47 +02:00
|
|
|
)
|
|
|
|
|
2022-11-08 09:47:38 +02:00
|
|
|
// Downloader ...
|
2020-02-19 20:26:47 +02:00
|
|
|
type Downloader interface {
|
|
|
|
SetOptions(options ClientOptions)
|
|
|
|
DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// DownloadFile downloads a file's content as GET request from the specified URL to the specified file
|
|
|
|
func (c *Client) DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error {
|
2020-02-20 13:46:32 +02:00
|
|
|
return c.DownloadRequest(http.MethodGet, url, filename, header, cookies)
|
2020-02-19 20:26:47 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// DownloadRequest ...
|
|
|
|
func (c *Client) DownloadRequest(method, url, filename string, header http.Header, cookies []*http.Cookie) error {
|
|
|
|
response, err := c.SendRequest(method, url, nil, header, cookies)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrapf(err, "HTTP %v request to %v failed with error", method, url)
|
|
|
|
}
|
|
|
|
defer response.Body.Close()
|
2020-02-25 17:52:12 +02:00
|
|
|
parent := filepath.Dir(filename)
|
|
|
|
if len(parent) > 0 {
|
|
|
|
if err = os.MkdirAll(parent, 0775); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
2020-02-19 20:26:47 +02:00
|
|
|
fileHandler, err := os.Create(filename)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrapf(err, "unable to create file %v", filename)
|
|
|
|
}
|
|
|
|
defer fileHandler.Close()
|
|
|
|
|
2021-06-23 14:41:52 +02:00
|
|
|
_, err = piperutils.CopyData(fileHandler, response.Body)
|
2020-02-19 20:26:47 +02:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrapf(err, "unable to copy content from url to file %v", filename)
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
Changes for Pipeline Reporting (#3213)
* Adds GetLog() function to orchestrator
* Fixes BUILD_NUMBER env variable
* Fixes correct env var for JENKINS_HOME
* Adds getEnv to read env variables with default value, adds test for jenkins GetLog() implementation
* Adds possibility to read errorJsons; updates splunk package for log files (WIP)
* Uncommenting dev code
* Adds GetLog() function to orchestrator
* Fixes BUILD_NUMBER env variable
* Fixes correct env var for JENKINS_HOME
* Adds getEnv to read env variables with default value, adds test for jenkins GetLog() implementation
* Adds possibility to read errorJsons; updates splunk package for log files (WIP)
* Uncommenting dev code
* Adds GetRequest function which holds the response in memory (not saved to disk)
* Implements GetLog() function for ADO, adds function to read PipelineRuntime
* PAT has been revoked
* Changes http package, s.t. if password only is required basic auth works too
* Adds env variable for azure token, error handling in case of unauthenticated/nil response
* Adds logging output in case env variable can not be read and fallback variable needs to be used
* Adds usage of environment variables for auth, uses jenkins api
* Adds init functionality for orchestrators, updates GetLog() and GetPipelineStartTime() function
* Adds initaliziation function for orchestrator authetnication
* Adds settings struct for orchestrator authentication
* Adds function to whole logfile to Splunk
* Struct for pipeline related telemetry information
* Increase messagebatch size to 10k
* Changes splunk package to a pointer based implementation, updates generated files and corresponding template and tests for splunk
* Changes telemetry package to pointer based implementation to have multiple telemetry objects, adjusted tests and splunk implementation
* Changes content type to txt
* Send telemetry independent of logfiles, increases amount of messages per file
* Adds JobURL for orchestrators and UnknownOrchestrator as fallback
* telemetry makes use of orchestrator specific information
* Adds orchestrator independent correlationID
* Adds custom fields for pipeline status
* go fmt
* Removes env var test - no env variables are read anymore
* Use UnknownOrchestratorConfigProvider in case the orchestrator can not be initalized
* Removes Custom fields from telemetry as these can not be reflected in SWA
* Adds custom telemetry information (piperHash,..) to each step telemetry information
* Removes falltrough in case no orchestrator has been found
* Updates tests for orchestrator package
* Adds orchestrator import in generated files
* Updates generator files for internal library
* Adds orchestrator telemetry information to steps
* Updates generated files, fatalHook writes to cpe
* Go generate from master, go fmt
* Adds Custom Data field LastErrorCode
* Removes GetLog() test
* Update init_unix.go
* Update docker_integration_test_executor.go
* Update integration_api_cli_test.go
* Reverts go1.17 fmt formatting
* Reverts go1.17 fmt formatting
* Reverts go1.17 fmt formatting
* Renames customTelemetryData to stepTelemetryData
* Adjustments to orchestrator-package, cleanup, adds JobName
* Adjusts commonPipelineEnvironment path
* Adds pipelineTelemetry struct to telemetry package, removes pipeline telemetry structs from splunk package
* Go fmt
* Changes path for errorDetails, adds debug information
* Removes custom fields from step, adds orchestrator, commithash to baseMetadata
* Adjusts tests for telemetry package
* Adds tests for orchestrator
* Updates generated files, initalization of splunk client only if its available in the config
* Fixes typo in helper go
* Update pkg/http/downloader.go
* Update pkg/http/downloader.go
* Update pkg/log/fatalHook.go
* Update fatalHook.go
* Update pkg/splunk/splunk.go
* Update pkg/telemetry/data.go
* Adds GetBuildStatus() and GetAPIInformation() to orchestrators
* error formatting
* Bugfix: dont send telemetry data if disabled, adjusts test
* go fmt
* Use correct error handling
* Update pkg/telemetry/telemetry.go
* Fixes telemetry disabled in the tests
* Fixes http tests
* Log fatal errors to logFile
* Adds CustomReportingConfig to hooks
* Cleanup comments in splunk package
* Adds possibility to send telemetry to custom endpoint
* Adds debug output for the payload
* Debug output for the payload as a string
* Adds test cases for changes in telemetry package
* go fmt
* Adds generated files for new step
* Reverts changes for http tests, causing problems with go1.15, changes need to be applied for newer go version >=1.17
* Adjusts test for sonarExecuteScan
* Adjusts test for sonarExecuteScan
* Adds explanation for customreportingConfig
* Makes disableing of customSend more obvious
* Adds custom step reporting to each step, updates generated files, adjusts helper testdata
* fixes unit test wrong usage of logging
* Send pipeline data altough there has been no error, adjust test cases
* Reverts changes for customReporting
* Updates generated files, removes customReporting
* Removes writing errorDetails to CPE
* Reverts usage of customreporting
* go fmt
* reverts changes in http_test
* reverts changes in http_test
* Skips integration cnb test
Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
2021-11-18 18:50:03 +02:00
|
|
|
|
|
|
|
// GetRequest downloads content from a given URL and returns the response instead of writing it to file
|
|
|
|
func (c *Client) GetRequest(url string, header http.Header, cookies []*http.Cookie) (*http.Response, error) {
|
|
|
|
response, err := c.SendRequest("GET", url, nil, header, cookies)
|
|
|
|
if err != nil {
|
|
|
|
return &http.Response{}, errors.Wrapf(err, "HTTP request to %v failed with error", url)
|
|
|
|
}
|
|
|
|
return response, nil
|
|
|
|
}
|
2022-06-29 12:00:37 +02:00
|
|
|
|
|
|
|
// DownloadExecutable downloads a script or another executable and sets appropriate permissions
|
|
|
|
func DownloadExecutable(githubToken string, fileUtils piperutils.FileUtils, downloader Downloader, url string) (string, error) {
|
|
|
|
header := http.Header{}
|
|
|
|
if len(githubToken) > 0 {
|
|
|
|
header = http.Header{"Authorization": []string{"Token " + githubToken}}
|
|
|
|
header.Set("Accept", "application/vnd.github.v3.raw")
|
|
|
|
}
|
|
|
|
|
|
|
|
fileNameParts := strings.Split(url, "/")
|
|
|
|
fileName := fileNameParts[len(fileNameParts)-1]
|
|
|
|
fullFileName := filepath.Join(".pipeline", fileName)
|
|
|
|
err := downloader.DownloadFile(url, fullFileName, header, []*http.Cookie{})
|
|
|
|
if err != nil {
|
|
|
|
return "", errors.Wrapf(err, "unable to download script from %v", url)
|
|
|
|
}
|
|
|
|
err = fileUtils.Chmod(fullFileName, 0555)
|
|
|
|
if err != nil {
|
|
|
|
return "", errors.Wrapf(err, "unable to change script permission for %v", fullFileName)
|
|
|
|
}
|
|
|
|
return fullFileName, nil
|
|
|
|
}
|