fix(#58): Refactors the Configuration trait

Adds a way to prefix some of the configuration parameters with a string (when it's useful) for using a same module with different parameters.

refactor(tests): Adds more tests

Adds new tests for each PowerModule

Author: mcolmant

powerapi-cli/src/main/scala/org/powerapi/app/PowerAPI.scala

@@ -26,12 +26,11 @@ import java.lang.management.ManagementFactory
 
 import org.powerapi.core.target.{Application, All, Process, Target}
 import org.powerapi.module.rapl.RAPLModule
-import org.powerapi.module.sigar.SigarModule
 import org.powerapi.reporter.{FileDisplay, JFreeChartDisplay, ConsoleDisplay}
 import org.powerapi.{PowerMonitoring, PowerMeter}
 import org.powerapi.core.power._
 import org.powerapi.module.cpu.dvfs.CpuDvfsModule
-import org.powerapi.module.cpu.simple.CpuSimpleModule
+import org.powerapi.module.cpu.simple.{SigarCpuSimpleModule, ProcFSCpuSimpleModule}
 import org.powerapi.module.libpfm.{LibpfmHelper, LibpfmCoreProcessModule, LibpfmCoreModule}
 import org.powerapi.module.powerspy.PowerSpyModule
 import scala.concurrent.duration.DurationInt
@@ -45,7 +44,7 @@ import scala.sys.process.stringSeqToProcess
  * @author <a href="mailto:[email protected]">Loïc Huertas</a>
  */
 object PowerAPI extends App {
-  val modulesR = """(cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl|sigar)(,(cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl|sigar))*""".r
+  val modulesR = """(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl)(,(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl))*""".r
   val aggR = """max|min|geomean|logsum|mean|median|stdev|sum|variance""".r
   val durationR = """\d+""".r
   val pidR = """(\d+)""".r
@@ -111,14 +110,16 @@ object PowerAPI extends App {
       """
         |PowerAPI, Spirals Team
         |
-        |Build a software-defined power meter. Do not forget to configure correctly the modules (see the documentation).
+        |Build a software-defined power meter. Do not forget to configure correctly the modules.
+        |You can use different settings per software-defined power meter for some modules by using the optional prefix option.
+        |Please, refer to the documentation inside the GitHub wiki for further details.
         |
-        |usage: ./powerapi modules [cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-proces|powerspy|rapl,...] \
+        |usage: ./powerapi modules [procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-proces|powerspy|rapl,...] *--prefix [name]* \
         |                          monitor --frequency [ms] --targets [pid, ..., app, ...|all] --agg [max|min|geomean|logsum|mean|median|stdev|sum|variance] --[console,file [filepath],chart] \
         |                  duration [s]
         |
-        |example: ./powerapi modules cpu-simple monitor --frequency 1000 --targets firefox --agg max --console monitor --targets chrome --agg max --console \
-        |                    modules powerspy monitor --frequency 1000 --targets all --agg max --console \
+        |example: ./powerapi modules procfs-cpu-simple monitor --frequency 1000 --targets firefox,chrome --agg max --console \
+        |                    modules powerspy --prefix powermeter2 monitor --frequency 1000 --targets all --agg max --console \
         |                    duration 30
       """.stripMargin
 
@@ -127,16 +128,21 @@ object PowerAPI extends App {
 
   def cli(options: List[Map[Symbol, Any]], duration: String, args: List[String]): (List[Map[Symbol, Any]], String) = args match {
     case Nil => (options, duration)
+    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validateModules(value) => {
+      val (remainingArgs, monitors) = cliMonitorsSubcommand(List(), Map(), tail.map(_.toString))
+      cli(options :+ Map('modules -> value, 'prefix -> Some(prefix), 'monitors -> monitors), duration, remainingArgs)
+    }
     case "modules" :: value :: "monitor" :: tail if validateModules(value) => {
       val (remainingArgs, monitors) = cliMonitorsSubcommand(List(), Map(), tail.map(_.toString))
-      cli(options :+ Map('modules -> value, 'monitors -> monitors), duration, remainingArgs)
+      cli(options :+ Map('modules -> value, 'prefix -> None, 'monitors -> monitors), duration, remainingArgs)
     }
     case "duration" :: value :: tail if validateDuration(value) => cli(options, value, tail)
     case option :: tail => println(s"unknown cli option $option"); sys.exit(1)
   }
 
   def cliMonitorsSubcommand(options: List[Map[Symbol, Any]], currentMonitor: Map[Symbol, Any], args: List[String]): (List[String], List[Map[Symbol, Any]]) = args match {
     case Nil => (List(), options :+ currentMonitor)
+    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validateModules(value) => (List("modules", value, "--prefix", prefix, "monitor") ++ tail, options :+ currentMonitor)
     case "modules" :: value :: "monitor" :: tail if validateModules(value) => (List("modules", value, "monitor") ++ tail, options :+ currentMonitor)
     case "duration" :: value :: tail if validateDuration(value) => (List("duration", value) ++ tail, options :+ currentMonitor)
     case "monitor" :: tail => cliMonitorsSubcommand(options :+ currentMonitor, Map(), tail)
@@ -155,7 +161,7 @@ object PowerAPI extends App {
   }
 
   else {
-    if(!System.getProperty("os.name").startsWith("Windows")) Seq("bash", "scripts/system.bash").!
+    if(System.getProperty("os.name").toLowerCase.indexOf("nix") >= 0 || System.getProperty("os.name").toLowerCase.indexOf("nux") >= 0) Seq("bash", "scripts/system.bash").!
     val (configuration, duration) = cli(List(), "3600", args.toList)
 
     var libpfmHelper: Option[LibpfmHelper] = None
@@ -166,17 +172,15 @@ object PowerAPI extends App {
     }
 
     for(powerMeterConf <- configuration) {
-      val modulesStr = powerMeterConf('modules).toString
-
-      val modules = (for(module <- modulesStr.split(",")) yield {
+      val modules = (for(module <- powerMeterConf('modules).toString.split(",")) yield {
         module match {
-          case "cpu-simple" => CpuSimpleModule()
+          case "procfs-cpu-simple" => ProcFSCpuSimpleModule()
+          case "sigar-cpu-simple" => SigarCpuSimpleModule()
           case "cpu-dvfs" => CpuDvfsModule()
-          case "libpfm-core" => LibpfmCoreModule(libpfmHelper.get)
-          case "libpfm-core-process" => LibpfmCoreProcessModule(libpfmHelper.get)
+          case "libpfm-core" => LibpfmCoreModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "libpfm-core-process" => LibpfmCoreProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
           case "powerspy" => PowerSpyModule()
           case "rapl" => RAPLModule()
-          case "sigar" => SigarModule()
         }
       }).toSeq
 

powerapi-core/src/main/scala/org/powerapi/PowerMeter.scala

@@ -48,7 +48,7 @@ object PowerMeterMessages {
 /**
  * Main configuration.
  */
-trait PowerMeterConfiguration extends Configuration {
+class PowerMeterConfiguration extends Configuration(None) {
   lazy val timeout: Timeout = load { _.getDuration("powerapi.actors.timeout", TimeUnit.MILLISECONDS) } match {
     case ConfigValue(value) => Timeout(value.milliseconds)
     case _ => Timeout(15l.seconds)
@@ -101,12 +101,12 @@ class PowerMeterActor(eventBus: MessageBus, modules: Seq[PowerModule], timeout:
 }
 
 /**
- * Implements the main functionalities for configuring a <i>Software-Defined Power Meter</i>.
+ * Implements the main features for configuring a <i>Software-Defined Power Meter</i>.
  *
  * @author <a href="mailto:[email protected]">Romain Rouvoy</a>
  * @author <a href="mailto:[email protected]">Loïc Huertas</a>
  */
-class PowerMeter(modules: Seq[PowerModule], system: ActorSystem) extends Configuration with PowerMeterConfiguration {
+class PowerMeter(system: ActorSystem, modules: Seq[PowerModule]) extends PowerMeterConfiguration {
   private val eventBus = new MessageBus
   private val powerMeterActor = system.actorOf(Props(classOf[PowerMeterActor], eventBus, modules, timeout))
 
@@ -147,18 +147,18 @@ class PowerMeter(modules: Seq[PowerModule], system: ActorSystem) extends Configu
 }
 
 object PowerMeter {
-  lazy val system = ActorSystem(s"PowerMeter-${System.nanoTime()}")
+  lazy val system = ActorSystem(s"PowerMeter-${System.nanoTime}")
 
   /**
    * Loads a specific power module as a tuple (sensor,formula).
    *
-   * Example: `PowerMeter.load(PowerSpyModule, system)`
+   * Example: `PowerMeter.loadModule(PowerSpyModule)`
    *
-   * @param modules: the list of power modules to be loaded within the PowerMeter.
+   * @param modules: PowerModule to be loaded within the PowerMeter.
    * @return the resulting instance of the requested power meter.
    */
   def loadModule(modules: PowerModule*): PowerMeter = {
-    new PowerMeter(modules, system)
+    new PowerMeter(system, modules)
   }
 }
 

powerapi-core/src/main/scala/org/powerapi/core/Configuration.scala

@@ -42,9 +42,15 @@ case class ConfigError[T](exception: Throwable) extends ConfigResult[T]
  *
  * @author <a href="mailto:[email protected]">Maxime Colmant</a>
  */
-trait Configuration {
+abstract class Configuration(prefix: Option[String] = None) {
   private lazy val conf = ConfigFactory.load()
 
+  val configurationPath = prefix match {
+    case Some(p) if p.endsWith(".") => s"$p"
+    case Some(p) => s"$p."
+    case None => ""
+  }
+
   /**
    * Method to load a value from a configuration file.
    *

powerapi-core/src/main/scala/org/powerapi/core/MonitorActors.scala

@@ -125,7 +125,7 @@ class MonitorChild(eventBus: MessageBus,
  *
  * @author Maxime Colmant <[email protected]>
  */
-class Monitors(eventBus: MessageBus) extends Supervisor with Configuration  {
+class Monitors(eventBus: MessageBus) extends Supervisor {
 
   override def preStart(): Unit = {
     subscribeMonitorsChannel(eventBus)(self)

powerapi-core/src/main/scala/org/powerapi/core/OSHelper.scala

@@ -32,7 +32,7 @@ import org.powerapi.core.FileHelper.using
 import org.powerapi.core.target.{All, Application, Process, Target, TargetUsageRatio}
 import org.powerapi.module.{Cache, CacheKey}
 import scala.collection.JavaConversions._
-import scala.sys.process._
+import scala.sys.process.stringSeqToProcess
 
 /**
  * This is not a monitoring target. It's an internal wrapper for the Thread IDentifier.
@@ -161,7 +161,7 @@ trait OSHelper {
  *
  * @author <a href="mailto:[email protected]">Maxime Colmant</a>
  */
-class LinuxHelper extends OSHelper with Configuration {
+class LinuxHelper extends Configuration(None) with OSHelper {
   private val log = LogManager.getLogger
 
   private val PSFormat = """^\s*(\d+)\s*""".r
@@ -172,15 +172,15 @@ class LinuxHelper extends OSHelper with Configuration {
    * This file allows to get all the cpu frequencies with the help of procfs and cpufreq_utils.
    */
   lazy val frequenciesPath = load { _.getString("powerapi.procfs.frequencies-path") } match {
-    case ConfigValue(path) if path.contains("%?core") => path
+    case ConfigValue(p) if p.contains("%?core") => p
     case _ => "/sys/devices/system/cpu/cpu%?core/cpufreq/scaling_available_frequencies"
   }
 
   /**
    * This file allows to get all threads associated to one PID with the help of the procfs.
    */
   lazy val taskPath = load { _.getString("powerapi.procfs.process-task-path") } match {
-    case ConfigValue(path) if path.contains("%?pid") => path
+    case ConfigValue(p) if p.contains("%?pid") => p
     case _ => "/proc/%?pid/task"
   }
 
@@ -189,7 +189,7 @@ class LinuxHelper extends OSHelper with Configuration {
    * Typically presents under /proc/stat.
    */
   lazy val globalStatPath = load { _.getString("powerapi.procfs.global-path") } match {
-    case ConfigValue(path) => path
+    case ConfigValue(p) => p
     case _ => "/proc/stat"
   }
 
@@ -198,15 +198,15 @@ class LinuxHelper extends OSHelper with Configuration {
    * Typically presents under /proc/[pid]/stat.
    */
   lazy val processStatPath = load { _.getString("powerapi.procfs.process-path") } match {
-    case ConfigValue(path) if path.contains("%?pid") => path
+    case ConfigValue(p) if p.contains("%?pid") => p
     case _ => "/proc/%?pid/stat"
   }
 
   /**
    * Time in state file, giving information about how many time CPU spent under each frequency.
    */
   lazy val timeInStatePath = load { _.getString("powerapi.sysfs.timeinstates-path") } match {
-    case ConfigValue(path) => path
+    case ConfigValue(p) => p
     case _ => "/sys/devices/system/cpu/cpu%?index/cpufreq/stats/time_in_state"
   }
 
@@ -371,14 +371,14 @@ class LinuxHelper extends OSHelper with Configuration {
  *
  * @author <a href="mailto:[email protected]">Loïc Huertas</a>
  */
-class SigarHelper extends OSHelper with Configuration {
+class SigarHelper extends Configuration(None) with OSHelper {
   private val log = LogManager.getLogger
 
   /**
    * Sigar native libraries
    */
   lazy val libNativePath = load { _.getString("powerapi.sigar.native-path") } match {
-    case ConfigValue(path) => path
+    case ConfigValue(p) => p
     case _ => "./lib"
   }
 

powerapi-core/src/main/scala/org/powerapi/module/cpu/dvfs/CpuDvfsModule.scala

@@ -22,19 +22,18 @@
  */
 package org.powerapi.module.cpu.dvfs
 
-import com.typesafe.config.Config
 import org.powerapi.PowerModule
-import org.powerapi.core.{Configuration, ConfigValue, LinuxHelper}
+import org.powerapi.core.{OSHelper, LinuxHelper}
 
-import scala.collection.JavaConversions
-
-class CpuDvfsModule(tdp: Double, tdpFactor: Double, frequencies: Map[Int, Double]) extends PowerModule {
-  lazy val underlyingSensorsClasses  = Seq((classOf[CpuSensor], Seq(new LinuxHelper)))
+class CpuDvfsModule(osHelper: OSHelper, tdp: Double, tdpFactor: Double, frequencies: Map[Int, Double]) extends PowerModule {
+  lazy val underlyingSensorsClasses  = Seq((classOf[CpuSensor], Seq(osHelper)))
   lazy val underlyingFormulaeClasses = Seq((classOf[CpuFormula], Seq(tdp, tdpFactor, frequencies)))
 }
 
 object CpuDvfsModule extends CpuFormulaConfiguration {
   def apply(): CpuDvfsModule = {
-    new CpuDvfsModule(tdp, tdpFactor, frequencies)
+    val linuxHelper = new LinuxHelper
+
+    new CpuDvfsModule(linuxHelper, tdp, tdpFactor, frequencies)
   }
 }

powerapi-core/src/main/scala/org/powerapi/module/cpu/simple/CpuFormulaConfiguration.scala

@@ -45,7 +45,7 @@ trait CpuFormulaConfiguration extends Configuration {
    *
    * @see [1], JouleSort: A Balanced Energy-Efficiency Benchmark, by Rivoire et al.
    */
-  lazy val tdpFactor = load { _.getDouble("powerapi.cpu.tdp-factor") } match {
+  lazy val tdpFactor = load { _.getDouble(s"powerapi.cpu.tdp-factor") } match {
     case ConfigValue(value) => value
     case _ => 0.7
   }

powerapi-core/src/main/scala/org/powerapi/module/cpu/simple/CpuSensor.scala

@@ -57,9 +57,7 @@ class CpuSensor(eventBus: MessageBus, osHelper: OSHelper) extends SensorComponen
     publishUsageReport(monitorTick.muid, monitorTick.target, targetCpuUsageRatio(monitorTick), monitorTick.tick)(eventBus)
   }
 
-  def monitorStopped(msg: MonitorStop): Unit = {
-  }
+  def monitorStopped(msg: MonitorStop): Unit = {}
 
-  def monitorAllStopped(msg: MonitorStopAll): Unit = {
-  }
+  def monitorAllStopped(msg: MonitorStopAll): Unit = {}
 }

powerapi-core/src/main/scala/org/powerapi/module/cpu/simple/CpuSimpleModule.scala

@@ -23,15 +23,25 @@
 package org.powerapi.module.cpu.simple
 
 import org.powerapi.PowerModule
-import org.powerapi.core.{Configuration, ConfigValue, LinuxHelper}
+import org.powerapi.core.{SigarHelper, LinuxHelper, OSHelper}
 
-class CpuSimpleModule(tdp: Double, tdpFactor: Double) extends PowerModule {
-  lazy val underlyingSensorsClasses  = Seq((classOf[CpuSensor], Seq(new LinuxHelper)))
+class CpuSimpleModule(osHelper: OSHelper, tdp: Double, tdpFactor: Double) extends PowerModule {
+  lazy val underlyingSensorsClasses  = Seq((classOf[CpuSensor], Seq(osHelper)))
   lazy val underlyingFormulaeClasses = Seq((classOf[CpuFormula], Seq(tdp, tdpFactor)))
 }
 
-object CpuSimpleModule extends CpuFormulaConfiguration {
+object ProcFSCpuSimpleModule extends CpuFormulaConfiguration {
   def apply(): CpuSimpleModule = {
-    new CpuSimpleModule(tdp, tdpFactor)
+    val linuxHelper = new LinuxHelper
+
+    new CpuSimpleModule(linuxHelper, tdp, tdpFactor)
+  }
+}
+
+object SigarCpuSimpleModule extends CpuFormulaConfiguration {
+  def apply(): CpuSimpleModule = {
+    val sigarHelper = new SigarHelper
+
+    new CpuSimpleModule(sigarHelper, tdp, tdpFactor)
   }
 }

powerapi-core/src/main/scala/org/powerapi/module/libpfm/LibpfmCoreModule.scala

@@ -35,15 +35,14 @@ class LibpfmCoreModule(libpfmHelper: LibpfmHelper, timeout: Timeout, topology: M
   lazy val underlyingFormulaeClasses = Seq((classOf[LibpfmCoreCyclesFormula], Seq(cyclesThreadName, cyclesRefName, formulae, samplingInterval)))
 }
 
-object LibpfmCoreModule extends LibpfmCoreSensorConfiguration with LibpfmCoreCyclesFormulaConfiguration {
-  lazy val libpfmHelper = new LibpfmHelper
+object LibpfmCoreModule {
+  def apply(prefixConfig: Option[String] = None, libpfmHelper: LibpfmHelper): LibpfmCoreModule = {
+    val coreSensorConfig = new LibpfmCoreSensorConfiguration(prefixConfig)
+    val coreCyclesFormulaConfig = new LibpfmCoreCyclesFormulaConfiguration(prefixConfig)
 
-  def apply(): LibpfmCoreModule = {
-    new LibpfmCoreModule(libpfmHelper, timeout, topology, configuration, events, cyclesThreadName, cyclesRefName, formulae, samplingInterval)
-  }
-
-  def apply(libpfmHelper: LibpfmHelper): LibpfmCoreModule = {
-    new LibpfmCoreModule(libpfmHelper, timeout, topology, configuration, events, cyclesThreadName, cyclesRefName, formulae, samplingInterval)
+    new LibpfmCoreModule(libpfmHelper, coreSensorConfig.timeout, coreSensorConfig.topology, coreSensorConfig.configuration,
+      coreSensorConfig.events, coreCyclesFormulaConfig.cyclesThreadName, coreCyclesFormulaConfig.cyclesRefName,
+      coreCyclesFormulaConfig.formulae, coreCyclesFormulaConfig.samplingInterval)
   }
 }
 
@@ -52,22 +51,16 @@ class LibpfmCoreSensorModule(libpfmHelper: LibpfmHelper, timeout: Timeout, topol
   lazy val underlyingFormulaeClasses = Seq()
 }
 
-object LibpfmCoreSensorModule extends LibpfmCoreSensorConfiguration {
-  lazy val libpfmHelper = new LibpfmHelper
+object LibpfmCoreSensorModule {
+  def apply(prefixConfig: Option[String] = None, libpfmHelper: LibpfmHelper): LibpfmCoreSensorModule = {
+    val coreSensorConfig = new LibpfmCoreSensorConfiguration(prefixConfig)
 
-  def apply(): LibpfmCoreSensorModule = {
-    new LibpfmCoreSensorModule(libpfmHelper, timeout, topology, configuration, events)
+    new LibpfmCoreSensorModule(libpfmHelper, coreSensorConfig.timeout, coreSensorConfig.topology, coreSensorConfig.configuration, coreSensorConfig.events)
   }
 
-  def apply(libpfmHelper: LibpfmHelper): LibpfmCoreSensorModule = {
-    new LibpfmCoreSensorModule(libpfmHelper, timeout, topology, configuration, events)
-  }
-
-  def apply(events: Set[String]): LibpfmCoreSensorModule = {
-    new LibpfmCoreSensorModule(libpfmHelper, timeout, topology, configuration, events)
-  }
+  def apply(prefixConfig: Option[String], libpfmHelper: LibpfmHelper, events: Set[String]): LibpfmCoreSensorModule = {
+    val coreSensorConfig = new LibpfmCoreSensorConfiguration(prefixConfig)
 
-  def apply(libpfmHelper: LibpfmHelper, events: Set[String]): LibpfmCoreSensorModule = {
-    new LibpfmCoreSensorModule(libpfmHelper, timeout, topology, configuration, events)
+    new LibpfmCoreSensorModule(libpfmHelper, coreSensorConfig.timeout, coreSensorConfig.topology, coreSensorConfig.configuration, events)
   }
 }