moved all paths into CmdOptions struct

Author: mwfarb

webapp/lib/bwcont.go

@@ -151,7 +151,7 @@ func ExtractBwtestRespData(resp string, d *model.BwTestItem, start time.Time) {
 }
 
 // GetBwByTimeHandler request the bwtest results stored since provided time.
-func GetBwByTimeHandler(w http.ResponseWriter, r *http.Request, active bool, srcpath string) {
+func GetBwByTimeHandler(w http.ResponseWriter, r *http.Request, active bool) {
 	r.ParseForm()
 	since := r.PostFormValue("since")
 	log.Info("Requesting bwtest data since", "timestamp", since)
@@ -187,10 +187,10 @@ func removeOuterQuotes(s string) string {
 }
 
 // WriteCmdCsv appends the cmd data (bwtest or echo) in csv-format to srcpath.
-func WriteCmdCsv(d model.CmdItem, srcpath string, appSel string) {
+func WriteCmdCsv(d model.CmdItem, options *CmdOptions, appSel string) {
 	// newfile name for every day
 	dataFileCmd := "data/" + appSel + "-" + time.Now().Format("2006-01-02") + ".csv"
-	cmdDataPath := path.Join(srcpath, dataFileCmd)
+	cmdDataPath := path.Join(options.StaticRoot, dataFileCmd)
 	// write headers if file is new
 	writeHeader := false
 	if _, err := os.Stat(dataFileCmd); os.IsNotExist(err) {

webapp/lib/config.go

@@ -35,19 +35,23 @@ type UserSetting struct {
 	MyIA string `json:"myIa"`
 }
 
+type CmdOptions struct {
+	StaticRoot, BrowseRoot, AppsRoot, ScionRoot, ScionBin, ScionGen, ScionGenCache, ScionLogs string
+}
+
 // WriteUserSetting writes the settings to disk.
-func WriteUserSetting(srcpath string, settings UserSetting) {
-	cliUserFp := path.Join(srcpath, cfgFileCliUser)
+func WriteUserSetting(options *CmdOptions, settings UserSetting) {
+	cliUserFp := path.Join(options.StaticRoot, cfgFileCliUser)
 	settingsJSON, _ := json.Marshal(settings)
 
 	err := ioutil.WriteFile(cliUserFp, settingsJSON, 0644)
 	CheckError(err)
 }
 
 // ReadUserSetting reads the settings from disk.
-func ReadUserSetting(srcpath string) UserSetting {
+func ReadUserSetting(options *CmdOptions) UserSetting {
 	var settings UserSetting
-	cliUserFp := path.Join(srcpath, cfgFileCliUser)
+	cliUserFp := path.Join(options.StaticRoot, cfgFileCliUser)
 
 	// no problem when user settings not set yet
 	raw, err := ioutil.ReadFile(cliUserFp)
@@ -59,11 +63,11 @@ func ReadUserSetting(srcpath string) UserSetting {
 }
 
 // ScanLocalIAs will load list of locally available IAs
-func ScanLocalIAs(scionRoot string) []string {
+func ScanLocalIAs(options *CmdOptions) []string {
 	var localIAs []string
 	var reIaFilePathCap = `\/ISD([0-9]+)\/AS(\w+)`
 	re := regexp.MustCompile(reIaFilePathCap)
-	var searchPath = path.Join(scionRoot, "gen")
+	var searchPath = path.Join(options.ScionRoot, "gen")
 	filepath.Walk(searchPath, func(path string, f os.FileInfo, _ error) error {
 		if f != nil && f.IsDir() {
 			capture := re.FindStringSubmatch(path)
@@ -129,11 +133,11 @@ func (c byPrefInterface) Less(i, j int) bool {
 }
 
 // GenServerNodeDefaults creates server defaults for localhost testing
-func GenServerNodeDefaults(srcpath string, localIAs []string) {
+func GenServerNodeDefaults(options *CmdOptions, localIAs []string) {
 	// reverse sort so that the default server will oppose the default client
 	sort.Sort(sort.Reverse(sort.StringSlice(localIAs)))
 
-	serFp := path.Join(srcpath, cfgFileSerUser)
+	serFp := path.Join(options.StaticRoot, cfgFileSerUser)
 	jsonBuf := []byte(`{ "all": [`)
 	for i := 0; i < len(localIAs); i++ {
 		// use all localhost endpoints as possible servers for bwtester as least
@@ -152,8 +156,8 @@ func GenServerNodeDefaults(srcpath string, localIAs []string) {
 
 // GenClientNodeDefaults queries network interfaces and writes local client
 // SCION addresses as json
-func GenClientNodeDefaults(srcpath, cisdas string) {
-	cliFp := path.Join(srcpath, cfgFileCliDef)
+func GenClientNodeDefaults(options *CmdOptions, cisdas string) {
+	cliFp := path.Join(options.StaticRoot, cfgFileCliDef)
 	cport := cliPortDef
 
 	// find interface addresses
@@ -191,19 +195,19 @@ func GenClientNodeDefaults(srcpath, cisdas string) {
 }
 
 // GetNodesHandler queries the local environment for user/default nodes.
-func GetNodesHandler(w http.ResponseWriter, r *http.Request, srcpath string) {
+func GetNodesHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions) {
 	r.ParseForm()
 	nodes := r.PostFormValue("node_type")
 	var fp string
 	switch nodes {
 	case "clients_default":
-		fp = path.Join(srcpath, cfgFileCliDef)
+		fp = path.Join(options.StaticRoot, cfgFileCliDef)
 	case "servers_default":
-		fp = path.Join(srcpath, cfgFileSerDef)
+		fp = path.Join(options.StaticRoot, cfgFileSerDef)
 	case "clients_user":
-		fp = path.Join(srcpath, cfgFileCliUser)
+		fp = path.Join(options.StaticRoot, cfgFileCliUser)
 	case "servers_user":
-		fp = path.Join(srcpath, cfgFileSerUser)
+		fp = path.Join(options.StaticRoot, cfgFileSerUser)
 	default:
 		panic("Unhandled nodes type!")
 	}

webapp/lib/echocont.go

@@ -107,7 +107,7 @@ func ExtractEchoRespData(resp string, d *model.EchoItem, start time.Time) {
 }
 
 // GetEchoByTimeHandler request the echo results stored since provided time.
-func GetEchoByTimeHandler(w http.ResponseWriter, r *http.Request, active bool, srcpath string) {
+func GetEchoByTimeHandler(w http.ResponseWriter, r *http.Request, active bool) {
 	r.ParseForm()
 	since := r.PostFormValue("since")
 	log.Info("Requesting echo data since", "timestamp", since)

webapp/lib/health.go

@@ -45,33 +45,33 @@ type ResHealthCheck struct {
 
 // HealthCheckHandler handles calling the default health-check scripts and
 // returning the json-formatted results of each script.
-func HealthCheckHandler(w http.ResponseWriter, r *http.Request, scionRoot string, srcpath string, ia string) {
-	hcResFp := path.Join(srcpath, resFileHealthCheck)
+func HealthCheckHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions, ia string) {
+	hcResFp := path.Join(options.StaticRoot, resFileHealthCheck)
 	// read specified tests from json definition
-	fp := path.Join(srcpath, defFileHealthCheck)
+	fp := path.Join(options.StaticRoot, defFileHealthCheck)
 	raw, err := ioutil.ReadFile(fp)
 	if CheckError(err) {
 		fmt.Fprintf(w, `{ "err": "`+err.Error()+`" }`)
 		return
 	}
 	log.Debug("HealthCheckHandler", "resFileHealthCheck", string(raw))
 
-	err = os.Setenv("SCION_ROOT", scionRoot+"/")
+	err = os.Setenv("SCION_ROOT", options.ScionRoot+"/")
 	if CheckError(err) {
 		fmt.Fprintf(w, `{ "err": "`+err.Error()+`" }`)
 		return
 	}
-	err = os.Setenv("SCION_BIN", scionRoot+"/bin/")
+	err = os.Setenv("SCION_BIN", options.ScionBin+"/")
 	if CheckError(err) {
 		fmt.Fprintf(w, `{ "err": "`+err.Error()+`" }`)
 		return
 	}
-	err = os.Setenv("SCION_GEN", scionRoot+"/gen/")
+	err = os.Setenv("SCION_GEN", options.ScionGen+"/")
 	if CheckError(err) {
 		fmt.Fprintf(w, `{ "err": "`+err.Error()+`" }`)
 		return
 	}
-	err = os.Setenv("SCION_LOGS", scionRoot+"/logs/")
+	err = os.Setenv("SCION_LOGS", options.ScionLogs+"/")
 	if CheckError(err) {
 		fmt.Fprintf(w, `{ "err": "`+err.Error()+`" }`)
 		return

webapp/lib/image.go

@@ -72,8 +72,8 @@ func findNewestFileExt(dir, extRegEx string) (imgFilename string, imgTimestamp i
 }
 
 // FindImageInfoHandler locating most recent image and writing text info data about it.
-func FindImageInfoHandler(w http.ResponseWriter, r *http.Request, staticRoot string) {
-	filesDir := path.Join(staticRoot, "data/images")
+func FindImageInfoHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions) {
+	filesDir := path.Join(options.StaticRoot, "data/images")
 	imgFilename, _ := findNewestFileExt(filesDir, regexImageFiles)
 	if imgFilename == "" {
 		return
@@ -83,8 +83,8 @@ func FindImageInfoHandler(w http.ResponseWriter, r *http.Request, staticRoot str
 }
 
 // FindImageHandler locating most recent image formatting it for graphic display in response.
-func FindImageHandler(w http.ResponseWriter, r *http.Request, staticRoot string, browserAddr string, port int) {
-	filesDir := path.Join(staticRoot, "data/images")
+func FindImageHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions, browserAddr string, port int) {
+	filesDir := path.Join(options.StaticRoot, "data/images")
 	imgFilename, _ := findNewestFileExt(filesDir, regexImageFiles)
 	if imgFilename == "" {
 		fmt.Fprint(w, "Error: Unable to find image file locally.")

webapp/lib/sciond.go

@@ -82,7 +82,7 @@ func getNetworkByIA(iaCli string) (*snet.SCIONNetwork, error) {
 // sciond data sources and calls
 
 // PathTopoHandler handles requests for paths, returning results from sciond.
-func PathTopoHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
+func PathTopoHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions) {
 	r.ParseForm()
 	SIa := r.PostFormValue("ia_ser")
 	CIa := r.PostFormValue("ia_cli")
@@ -116,7 +116,7 @@ func PathTopoHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
 
 	// Since segments data is supplimentary to paths data, if segments data
 	// fails, provide the error, but we must still allow paths data to return.
-	segments, err := getSegmentsJSON(*clientCCAddr, scionRoot)
+	segments, err := getSegmentsJSON(*clientCCAddr, options)
 	if CheckError(err) {
 		returnPathHandler(w, paths, nil, err)
 		return
@@ -126,9 +126,9 @@ func PathTopoHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
 	returnPathHandler(w, paths, segments, err)
 }
 
-func getSegmentsJSON(local snet.Addr, scionRoot string) ([]byte, error) {
+func getSegmentsJSON(local snet.Addr, options *CmdOptions) ([]byte, error) {
 	// load segments from paths database
-	var dbSrcFile = findDBFilename(local.IA, scionRoot)
+	var dbSrcFile = findDBFilename(local.IA, options)
 	dbTmpFile, err := copyDBToTemp(dbSrcFile)
 	if err != nil {
 		return nil, err
@@ -168,14 +168,14 @@ func getSegmentsJSON(local snet.Addr, scionRoot string) ([]byte, error) {
 	return jsonSegsInfo, nil
 }
 
-func findDBFilename(ia addr.IA, scionRoot string) string {
-	filenames, err := filepath.Glob(filepath.Join(scionRoot, "gen-cache", "ps*path.db"))
+func findDBFilename(ia addr.IA, options *CmdOptions) string {
+	filenames, err := filepath.Glob(filepath.Join(options.ScionGenCache, "ps*path.db"))
 	CheckError(err)
 	if len(filenames) == 1 {
 		return filenames[0]
 	}
 	pathDBFileName := fmt.Sprintf("ps%s-1.path.db", ia.FileFmt(false))
-	return filepath.Join(scionRoot, "gen-cache", pathDBFileName)
+	return filepath.Join(options.ScionGenCache, pathDBFileName)
 }
 
 // returns the name of the created file
@@ -288,10 +288,10 @@ func AsTopoHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 // TrcHandler handles requests for all local trust root data.
-func TrcHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
+func TrcHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions) {
 	r.ParseForm()
 	CIa := r.PostFormValue("src")
-	raw, err := loadJSONCerts(CIa, "*.trc", scionRoot)
+	raw, err := loadJSONCerts(CIa, "*.trc", options)
 	if CheckError(err) {
 		returnError(w, err)
 		return
@@ -301,10 +301,10 @@ func TrcHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
 }
 
 // CrtHandler handles requests for all local certificate data.
-func CrtHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
+func CrtHandler(w http.ResponseWriter, r *http.Request, options *CmdOptions) {
 	r.ParseForm()
 	CIa := r.PostFormValue("src")
-	raw, err := loadJSONCerts(CIa, "*.crt", scionRoot)
+	raw, err := loadJSONCerts(CIa, "*.crt", options)
 	if CheckError(err) {
 		returnError(w, err)
 		return
@@ -313,13 +313,13 @@ func CrtHandler(w http.ResponseWriter, r *http.Request, scionRoot string) {
 	fmt.Fprintf(w, string(raw))
 }
 
-func loadJSONCerts(src, pattern string, scionRoot string) ([]byte, error) {
+func loadJSONCerts(src, pattern string, options *CmdOptions) ([]byte, error) {
 	ia, err := addr.IAFromString(src)
 	if err != nil {
 		return nil, err
 	}
-	certDir := path.Join(scionRoot, fmt.Sprintf("gen/ISD%d/AS%s/endhost/certs", ia.I, ia.A.FileFmt()))
-	cacheDir := path.Join(scionRoot, "gen-cache")
+	certDir := path.Join(options.ScionGen, fmt.Sprintf("ISD%d/AS%s/endhost/certs", ia.I, ia.A.FileFmt()))
+	cacheDir := options.ScionGenCache
 	files, err := filepath.Glob(fmt.Sprintf("%s/%s", certDir, pattern))
 	if err != nil {
 		return nil, err

webapp/lib/traceroutecont.go

@@ -120,7 +120,7 @@ func handleHopData(line string, runTimeKey int64) {
 }
 
 // GetTracerouteByTimeHandler request the traceroute results stored since provided time.
-func GetTracerouteByTimeHandler(w http.ResponseWriter, r *http.Request, active bool, srcpath string) {
+func GetTracerouteByTimeHandler(w http.ResponseWriter, r *http.Request, active bool) {
 	r.ParseForm()
 	since := r.PostFormValue("since")
 	log.Info("Requesting traceroute data since", "timestamp", since)

webapp/tests/health/beaconstest.sh

@@ -11,12 +11,12 @@ pcb_ms=10000
 iaFile=$(echo $1 | sed "s/:/_/g")
 echo "IA found: $iaFile"
 
-# format log file and beacons grep string
-logfile=$SCION_LOGS/bs${iaFile}-1.DEBUG
+# format log file and beacons grep string (was .DEBUG)
+logfile=$SCION_LOGS/bs${iaFile}-1.log
 echo "Log: $logfile"
 
-# seek last log entry for verified PCBs
-regex_pcb="Successfully verified PCB"
+# seek last log entry for verified PCBs (was "Successfully verified PCB")
+regex_pcb="Registered beacons"
 echo "Seeking regex: $regex_pcb"
 
 epoch_s=$(date +"%s%6N")