Merge pull request #179 from angelabriel/master

Changes as result of the tests in the last week

Author: angelabriel

actions/actions.go

@@ -103,7 +103,7 @@ func SelectAction(writer io.Writer, stApp *app.App, saptuneVers string) {
 	case "configure":
 		ConfigureAction(writer, system.CliArg(2), system.CliArgs(3), stApp)
 	case "refresh":
-		RefreshAction(writer, system.CliArg(2), stApp)
+		RefreshAction(os.Stdin, writer, system.CliArg(2), stApp)
 	case "revert":
 		RevertAction(writer, system.CliArg(2), stApp)
 	case "staging":
@@ -121,11 +121,11 @@ func SelectAction(writer io.Writer, stApp *app.App, saptuneVers string) {
 }
 
 // RefreshAction refreshes all applied Notes
-func RefreshAction(writer io.Writer, actionName string, tuneApp *app.App) {
+func RefreshAction(reader io.Reader, writer io.Writer, actionName string, tuneApp *app.App) {
 	if actionName != "applied" {
 		PrintHelpAndExit(writer, 1)
 	}
-	NoteActionRefresh(writer, "", tuneApp)
+	NoteActionRefresh(reader, writer, "", tuneApp)
 }
 
 // VerifyAction verifies all applied Notes

actions/cmdsyntax.go

@@ -6,9 +6,9 @@ Daemon control:
   saptune [--format FORMAT] [--force-color] [--fun] daemon ( start | stop | status [--non-compliance-check] ) ATTENTION: deprecated
   saptune [--format FORMAT] [--force-color] [--fun] service ( start | stop | restart | takeover | enable | disable | enablestart | disablestop | status [--non-compliance-check] )
 Tune system according to SAP and SUSE notes:
-  saptune [--format FORMAT] [--force-color] [--fun] note ( list | verify | refresh | revertall | enabled | applied )
+  saptune [--format FORMAT] [--force-color] [--fun] note ( list | verify | revertall | enabled | applied )
   saptune [--format FORMAT] [--force-color] [--fun] note ( apply | simulate | customise | create | edit | revert | show | delete ) NOTEID
-  saptune [--format FORMAT] [--force-color] [--fun] note refresh [NOTEID|applied]
+  saptune [--format FORMAT] [--force-color] [--fun] note refresh [NOTEID|applied] ATTENTION: experimental
   saptune [--format FORMAT] [--force-color] [--fun] note verify [--colorscheme SCHEME] [--show-non-compliant] [NOTEID|applied]
   saptune [--format FORMAT] [--force-color] [--fun] note rename NOTEID NEWNOTEID
 Tune system for all notes applicable to your SAP solution:
@@ -27,7 +27,7 @@ Config (re-)settings:
 Verify all applied Notes:
   saptune [--format FORMAT] [--force-color] [--fun] verify applied
 Refresh all applied Notes:
-  saptune [--format FORMAT] [--force-color] [--fun] refresh applied
+  saptune [--format FORMAT] [--force-color] [--fun] refresh applied ATTENTION: experimental
 Revert all parameters tuned by the SAP notes or solutions:
   saptune [--format FORMAT] [--force-color] [--fun] revert all
 Remove the pending lock file from a former saptune call
@@ -55,9 +55,9 @@ func cmdLineSyntax16() string {
 Daemon control:
   saptune [--format FORMAT] [--force-color] [--fun] service ( start | stop | restart | takeover | enable | disable | enablestart | disablestop | status [--non-compliance-check] )
 Tune system according to SAP and SUSE notes:
-  saptune [--format FORMAT] [--force-color] [--fun] note ( list | verify | refresh | revertall | enabled | applied )
+  saptune [--format FORMAT] [--force-color] [--fun] note ( list | verify | revertall | enabled | applied )
   saptune [--format FORMAT] [--force-color] [--fun] note ( apply | customise | create | edit | revert | show | delete ) NOTEID
-  saptune [--format FORMAT] [--force-color] [--fun] note refresh [NOTEID|applied]
+  saptune [--format FORMAT] [--force-color] [--fun] note refresh [NOTEID|applied] ATTENTION: experimental
   saptune [--format FORMAT] [--force-color] [--fun] note verify [--colorscheme SCHEME] [--show-non-compliant] [NOTEID|applied]
   saptune [--format FORMAT] [--force-color] [--fun] note rename NOTEID NEWNOTEID
 Tune system for all notes applicable to your SAP solution:
@@ -76,7 +76,7 @@ Config (re-)settings:
 Verify all applied Notes:
   saptune [--format FORMAT] [--force-color] [--fun] verify applied
 Refresh all applied Notes:
-  saptune [--format FORMAT] [--force-color] [--fun] refresh applied
+  saptune [--format FORMAT] [--force-color] [--fun] refresh applied ATTENTION: experimental
 Revert all parameters tuned by the SAP notes or solutions:
   saptune [--format FORMAT] [--force-color] [--fun] revert all
 Remove the pending lock file from a former saptune call

actions/noteacts.go

@@ -40,7 +40,7 @@ func NoteAction(writer io.Writer, actionName, noteID, newNoteID string, tuneApp
 	case "delete":
 		NoteActionDelete(os.Stdin, writer, noteID, tuneApp)
 	case "refresh":
-		NoteActionRefresh(writer, noteID, tuneApp)
+		NoteActionRefresh(os.Stdin, writer, noteID, tuneApp)
 	case "rename":
 		NoteActionRename(os.Stdin, writer, noteID, newNoteID, tuneApp)
 	case "revert":
@@ -491,7 +491,14 @@ func NoteActionApplied(writer io.Writer, tuneApp *app.App) {
 
 // NoteActionRefresh re-applies Note parameter settings to the system
 // if an already applied Note got changed.
-func NoteActionRefresh(writer io.Writer, noteID string, tuneApp *app.App) {
+func NoteActionRefresh(reader io.Reader, writer io.Writer, noteID string, tuneApp *app.App) {
+	system.NoticeLog("ATTENTION: the action 'note refresh' is experimental!")
+	txtConfirm := fmt.Sprintf("Do you really want to continue to test this experimental action?")
+	if !readYesNo(txtConfirm, reader, writer) {
+		system.NoticeLog("Note action 'refresh' aborted by user interaction")
+		system.ErrorExit("", 0)
+	}
+
 	errCount := 0
 	noteList := make([]string, 0)
 	if noteID == "" || noteID == "applied" {

actions/stagingacts.go

@@ -523,7 +523,7 @@ func handleAppliedSolution(stageName string, tApp *app.App) {
 		for _, note := range sol {
 			// check, if in NoteApplyOrder
 			pos := tApp.PositionInNoteApplyOrder(note)
-		        if pos < 0 {
+			if pos < 0 {
 				// note not available, skip
 				continue
 			}

main.go

@@ -288,6 +288,7 @@ func checkSaptuneConfigFile(saptuneConf string) string {
 	if len(missingKey) != 0 {
 		system.ErrorExit("File '%s' is broken. Missing variables '%s'", saptuneConf, strings.Join(missingKey, ", "), 128)
 	}
+	// set internal 'excludeDirs' for later use during parsing Notes
 	txtparser.GetSysctlExcludes(sconf.GetString("SKIP_SYSCTL_FILES", ""))
 	stageVal := sconf.GetString("STAGING", "")
 	if stageVal != "true" && stageVal != "false" {

main_test.go

@@ -137,7 +137,6 @@ func TestCheckSaptuneConfigFile(t *testing.T) {
 	logSwitch := map[string]string{"verbose": "", "debug": ""}
 	// check saptune version and debug
 	saptuneConf := fmt.Sprintf("%s/saptune_VersAndDebug", TstFilesInGOPATH)
-	//buffer := bytes.Buffer{}
 
 	lSwitch := logSwitch
 	saptuneVers := checkSaptuneConfigFile(saptuneConf)
@@ -152,19 +151,14 @@ func TestCheckSaptuneConfigFile(t *testing.T) {
 		t.Errorf("wrong value for 'VERBOSE' - '%+v' instead of 'on'\n", lSwitch["debug"])
 	}
 
-	//buffer.Reset()
-
 	errExitbuffer := bytes.Buffer{}
 	tstwriter = &errExitbuffer
 
 	// check missing variable
 	saptuneConf = fmt.Sprintf("%s/saptune_MissingVar", TstFilesInGOPATH)
 	matchTxt := fmt.Sprintf("ERROR: File '%s' is broken. Missing variables 'COLOR_SCHEME'\n", saptuneConf)
-	//lSwitch = logSwitch
 	_ = checkSaptuneConfigFile(saptuneConf)
 
-	//txt := buffer.String()
-	//checkOut(t, txt, matchTxt)
 	if tstRetErrorExit != 128 {
 		t.Errorf("error exit should be '128' and NOT '%v'\n", tstRetErrorExit)
 	}
@@ -174,18 +168,14 @@ func TestCheckSaptuneConfigFile(t *testing.T) {
 	}
 
 	// initialise next test
-	//buffer.Reset()
 	errExitbuffer.Reset()
 
 	// check wrong STAGING value
 	saptuneConf = fmt.Sprintf("%s/saptune_WrongStaging", TstFilesInGOPATH)
 	saptuneVers = ""
 	matchTxt = fmt.Sprintf("ERROR: Variable 'STAGING' from file '%s' contains a wrong value 'hugo'. Needs to be 'true' or 'false'\n", saptuneConf)
-	//lSwitch = logSwitch
 	_ = checkSaptuneConfigFile(saptuneConf)
 
-	//txt = buffer.String()
-	//checkOut(t, txt, matchTxt)
 	if tstRetErrorExit != 128 {
 		t.Errorf("error exit should be '128' and NOT '%v'\n", tstRetErrorExit)
 	}

ospackage/man/saptune-note.5

@@ -56,13 +56,15 @@ Supported tags are:
 .BI os= <os_version>
 to define a special \fIos version\fP
 .br
-Valid values for \fBos=\fP are the values from the \fBVERSION=\fP line of \fB/etc/os-release\fP, e.g. 12-SP5, 12, 15, 15-SP5 or 16.0
-.br
-To mark an entire major release the string 12-*, 15-* or 16.* can be used.
-.br
-Additional there is the possibility to use a list or a range of valid releases (service packs, dot releases)
+Valid values for \fBos=\fP must match the value from the \fBVERSION=\fP line of \fB/etc/os-release\fP, e.g. 12-SP5, 12, 15, 15-SP5 or 16.0
+
+If \fBVERSION=\fP contains spaces, only the string until the first space is used for comparison. This excludes any suffixes - like for beta versions - from the comparison.
+
+To mark an entire major release the wildcard \fB*\fP in combination with a separator \fB-\fP or \fB.\fP (regardless of the one present in \fBVERSION\fP) can be used. Valid patterns are: 12-*, 12.*, 15-*, 15.*, 16-* or 16.*
+
+Additional there is the possibility to use a list or a range of valid service packs or dot releases. Again the separator can be \fB-\fP or \fB.\fP (regardless of the one present in \fBVERSION\fP). And for service packs (in 12/15) the \fISP\fP prefix should be omitted.
 .br
-e.g 15-[2,4-5,6-,-7]
+e.g 15-[2,4-5,6-,-7] or 15.[2,4-5,6-,-7]
 .TP
 .BI arch= <hardware_architecture>
 to define a special \fIhardware architecture\fP:
@@ -131,7 +133,9 @@ Example:
 .BI virt= <virtualization type>
 to define a special \fIvirtualization\fP class or type
 .br
-Valid class values for \fBvirt=\fP are \fBvm\fP, \fBchroot\fP and \fBcontainer\fP. Valid type values for \fBvirt=\fP are the output reported by \fI/usr/bin/systemd-detect-virt\fP
+Valid class values for \fBvirt=\fP are \fBvm\fP, \fBchroot\fP, \fBcontainer\fP and \fBbare-metal\fP.
+.br
+Valid type values for \fBvirt=\fP are the output reported by \fI/usr/bin/systemd-detect-virt\fP. If no virtualization is detected it's concidered as \fBbare-metal\fP
 
 .RS 4
 Example:

ospackage/man/saptune.8

@@ -30,13 +30,13 @@ ATTENTION: If you still use version \fB1\fP of saptune it's now time to migrate
 ( start | stop | restart | takeover | enable | disable | enablestart | disablestop | status [--non-compliance-check] )
 
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBnote\fP
-( list | verify | refresh | revertall | enabled | applied )
+( list | verify | revertall | enabled | applied )
 
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBnote\fP
 ( apply | simulate | customise | create | edit | revert | show | delete ) NOTEID
 
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBnote\fP
-refresh [NOTEID|applied]
+refresh [NOTEID|applied] \fBATTENTION: experimental\fP
 
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBnote\fP
 verify [--colorscheme SCHEME] [--show-non-compliant] [NOTEID|applied]
@@ -77,6 +77,9 @@ release [--force|--dry-run] [ ( NOTEID | SOLUTIONNAME.sol )... | all ]
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBverify\fP
 applied
 
+\fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBrefresh\fP
+applied \fBATTENTION: experimental\fP
+
 \fBsaptune\fP [--format FORMAT] [--force-color] [--fun] \fBrevert\fP
 all
 
@@ -474,11 +477,13 @@ This allows to create own Note definition files in \fI/etc/saptune/extra\fP. The
 The editor is defined by the \fBEDITOR\fP environment variable. If not set editor defaults to /usr/bin/vim.
 You need to choose an unique NoteID for this operation. Use '\fIsaptune note list\fP' to find the already used NoteIDs.
 .TP
-.B refresh
+.B refresh \fBATTENTION: experimental\fP
 Identifies and activates changed parameter settings of a Note definition. The changes get active without first reverting the 'old' settings, so the tuning of the system gets not interrupted.
 
 ATTENTION:
 .br
+This action is currently in the state \fBexperimental\fP!
+
 Currently only parameter of section "[sysctl]", "[sys]" and "[vm]" are supported by the \fIrefresh\fP action.
 
 Parameter of section "[version]", "[rpm]", "[grub]", "[fs]" and "[reminder]" are only checked by saptune, but not applied. So there is nothing to do during refresh of a note and these sections are skipped without notice.
@@ -787,7 +792,7 @@ Same as a \fIsaptune note verify\fP
 
 .SH REFRESH ACTIONS
 .TP
-.B refresh applied
+.B refresh applied \fBATTENTION: experimental\fP
 Refreshes all applied Notes.
 .br
 Same as a \fIsaptune note refresh\fP

ospackage/usr/share/saptune/notes/1275776

@@ -24,3 +24,9 @@ sysctl-logger.service=start
 #
 vm.max_map_count=2147483647
 
+# kernel.shmmni
+# The value is the maximum number of shared memory identifies available in the
+# system.
+# kernel.shmmni should be set to 32768
+#
+kernel.shmmni=32768

ospackage/usr/share/saptune/notes/2205917

@@ -36,7 +36,7 @@ THP=never
 #
 KSM=0
 
-[cpu:arch=x86_64]
+[cpu:arch=x86_64:virt=bare-metal]
 # Energy Performance Bias EPB (applies to Intel-based systems only)
 # energy_perf_bias: performance - 0, normal - 6, powersave - 15
 # cpupower set -b 0, if system supports Intel's performance bias setting
@@ -134,16 +134,17 @@ kernel-default 4.12.14-122.17
 # some of these values are set by saptune during runtime, so changing the
 # grub configuration is possible but not needed
 #
-# Configure C-States for lower latency in Linux (applies to Intel-based systems
-# only) - see energy_perf_bias and governor in section [cpu]
-intel_idle.max_cstate=1
-processor.max_cstate=1
-
 # Turn off autoNUMA balancing - see kernel.numa_balancing in section [sysctl]
 numa_balancing=disable
 # Disable transparent hugepages - see THP in section [vm]
 transparent_hugepage=never
 
+[grub:arch=x86_64:virt=bare-metal]
+# Configure C-States for lower latency in Linux (applies to Intel-based systems
+# only) - see energy_perf_bias and governor in section [cpu]
+intel_idle.max_cstate=1
+processor.max_cstate=1
+
 [reminder]
 # IBM EnergyScale for POWER8 Processor-Based Systems (applies to IBM Power systems only) - not handled by saptune!
 # IBM EnergyScale for POWER9 Processor-Based Systems (applies to IBM Power systems only) - not handled by saptune!