Merge pull request #7 from onera/6-adapt-readme-and-purge-tests

6 adapt readme and purge tests

Author: kevin-delmas

README.md

@@ -60,6 +60,20 @@ To use the standalone JAR with the GUI run:
 ```
 Note that by default the standalone JAR path is `target/scala-2.13/dalculator-assembly-X.Y.jar` (where X.Y is the version number).
 
+### Run tests using SBT
+
+You can perform the tests executing the examples in `src/test/resources`.
+Each example contains 
+- a set of command files used to specify a set of analysis
+- the sequences generated by the Cecilia Workshop tool and used by the Dalculator to perform the DAL allocation
+- some user constraints specifying costs, independence and DAL allocations constraints 
+- (FAZER example only) the results of the automatic FMEA from the Cecilia tool to perform a Probable Failure Qualitative Analysis (PFQA)
+
+All the tests will produce result files in `analysis` directory and are launched using the following command:
+```shell
+ sbt test
+```
+
 ### Installing the WBO Pseudo-Boolean solver (optional)
 The tool wbo1.4b-fixed can be obtained by contacting its author, Vasco Manquinho from INESC-ID in Portugal. 
 The binary of the solver must be placed in the `src/resources` folder.

src/main/scala/dalculator/DalculatorCore.scala

@@ -21,12 +21,13 @@ import dalculator.cli.DalculatorParameters
 import dalculator.model._
 import dalculator.solver.{SolveBudget, SolveDal, SolveIndep}
 import dalculator.translator.ModelParser
+import dalculator.utils.Configuration
 
 /** The entry point of the dalculator. */
 object DalculatorCore {
 
   /** Runs an analysis according to the given parameters. */
-  def apply(params: DalculatorParameters): Unit = {
+  def apply(params: DalculatorParameters)(implicit conf:Configuration): Unit = {
     this.clear()
     if (!(params.seqFiles.nonEmpty &&
       params.nSevs.length == params.seqFiles.length &&

src/main/scala/dalculator/cli/CLI.scala

@@ -19,6 +19,7 @@ package dalculator.cli
 
 import dalculator.DalculatorCore
 import dalculator.translator.ModelParser
+import dalculator.utils.Configuration
 
 object CLI {
 
@@ -42,7 +43,7 @@ object CLI {
       } else {
         ModelParser.loadParamsFile(opt, params)
         // run specified commands
-        DalculatorCore(params)
+        DalculatorCore(params)(Configuration.default)
       }
     }
   }

src/main/scala/dalculator/gui/DalculatorGuiWithListener.scala

@@ -30,6 +30,7 @@ import theory.pb.solver._
 import dalculator.cli._
 import dalculator.model.DalLevel._
 import dalculator.model._
+import dalculator.utils.Configuration
 
 import scala.language.postfixOps
 
@@ -194,7 +195,7 @@ class DalculatorGuiWithListener extends DalculatorGui with ActionListener {
           def doInBackground(): Unit = {
             frame.analysisThread = Some(this)
             println("analysis is running")
-            dalculator.DalculatorCore(params)
+            dalculator.DalculatorCore(params)(Configuration.default)
           }
 
           override def done(): Unit = {

src/main/scala/dalculator/model/FailureMode.scala

@@ -18,7 +18,7 @@
 package dalculator.model
 
 import dalculator.cli.DefaultParameters
-import dalculator.utils.{Stringpool, UniqueString}
+import dalculator.utils.{Configuration, Stringpool, UniqueString}
 
 /** Represents the failure mode 'name' of function 'function'. */
 class FailureMode(val name: UniqueString, val function: Item) {
@@ -99,11 +99,13 @@ object FailureMode extends Iterable[FailureMode] {
   }
 
   /** Simplified constructor, decomposes the given string to find 'func'.'name' */
-  def apply(name: String): FailureMode = {
+  def apply(name: String)(implicit conf:Configuration): FailureMode = {
     val s = name.split('.')
     if (s.length <= 1) {
-      println("[WARNING] FailureMode error: could not identify failure mode in function identifier because it is too short to be decomposed:" + name)
-      println(s"[WARNING] Assuming failure mode is implicit and $name is the name of the item or a common cause failure")
+      if(conf.printWarning) {
+        println("[WARNING] FailureMode error: could not identify failure mode in function identifier because it is too short to be decomposed:" + name)
+        println(s"[WARNING] Assuming failure mode is implicit and $name is the name of the item or a common cause failure")
+      }
       FailureMode("",Item(name))
     } else {
       // call normal constructor

src/main/scala/dalculator/translator/ModelParser.scala

@@ -19,6 +19,7 @@ package dalculator.translator
 
 import dalculator.cli.DalculatorParameters
 import dalculator.model._
+import dalculator.utils.Configuration
 import theory.pb.solver.{OpbSolver, Sat4jBoth, Sat4jCP, Sat4jRes}
 
 import java.io.{FileNotFoundException, FileReader}
@@ -45,10 +46,10 @@ object ModelParser extends RegexParsers {
   def qident: Parser[String] = "'" ~> ident <~ "'"
 
   /** Rule for a minmal cut set (a list of quoted identifiers). */
-  def cut: Parser[FailureModeList] = ("{" ~> repsep(qident, ",") <~ "}") ^^ (l => FailureModeList(l.map(f => FailureMode(f))))
+  def cut(implicit conf:Configuration): Parser[FailureModeList] = ("{" ~> repsep(qident, ",") <~ "}") ^^ (l => FailureModeList(l.map(f => FailureMode(f))))
 
   /** Rule for lists of minimal cut sets */
-  def cuts: Parser[List[FailureModeList]] = rep(cut)
+  def cuts(implicit conf:Configuration): Parser[List[FailureModeList]] = rep(cut)
 
   /** Rule for minimal cut sets header, contains name. */
   def fcname: Parser[String] = "products(MCS(" ~> qident <~ "))" ~ "="
@@ -63,7 +64,7 @@ object ModelParser extends RegexParsers {
    * @param xSev   the given xSev value is assigned to the parsed FC
    * @param refDal the given refDal is assigned to the parsed FC
    * */
-  def fc(model: Model, nSev: Int, xSev: BigDecimal, refDal: DalLevel): Parser[Model] = opt(comment) ~> fcname ~ cuts <~ "end" ~ opt(comment) ^^ {
+  def fc(model: Model, nSev: Int, xSev: BigDecimal, refDal: DalLevel)(implicit conf:Configuration): Parser[Model] = opt(comment) ~> fcname ~ cuts <~ "end" ~ opt(comment) ^^ {
     case name ~ cuts =>
       model.add(FailureCondition(name, nSev, xSev, cuts, refDal))
       model
@@ -76,7 +77,7 @@ object ModelParser extends RegexParsers {
    * @param xSev   the given xSev value is assigned to the parsed FC
    * @param refDal the given refDal is assigned to the parsed FC
    */
-  def loadFC(filename: String, model: Model, nSev: Int, xSev: BigDecimal, refDal: DalLevel): Unit = {
+  def loadFC(filename: String, model: Model, nSev: Int, xSev: BigDecimal, refDal: DalLevel)(implicit conf:Configuration): Unit = {
     val reader = try {
       new FileReader(filename)
     } catch {
@@ -310,24 +311,24 @@ object ModelParser extends RegexParsers {
   }
 
   /** Rule for user defined lambda bounds declaration */
-  def lambdaBounds: Parser[UserDefinedConstraint] = ("LambdaBounds(" ~> qident ~ "," ~ decimal ~ "," ~ decimal <~ ")") ^^ {
+  def lambdaBounds(implicit conf:Configuration): Parser[UserDefinedConstraint] = ("LambdaBounds(" ~> qident ~ "," ~ decimal ~ "," ~ decimal <~ ")") ^^ {
     case fm ~ _ ~ l ~ _ ~ u =>
       LambdaBoundsCstr(FailureMode(fm), l, u)
   }
 
   /** Rule for user defined latent failure mode declarations */
-  def latent: Parser[UserDefinedConstraint] = ("Latent(" ~> qident <~ ")") ^^ (fm => LatentCstr(FailureMode(fm)))
+  def latent(implicit conf:Configuration): Parser[UserDefinedConstraint] = ("Latent(" ~> qident <~ ")") ^^ (fm => LatentCstr(FailureMode(fm)))
 
   /** Rule for user defined latent failure mode declarations with special interval checks */
-  def latentItv: Parser[UserDefinedConstraint] = ("Latent(" ~> qident ~ "," ~ repsep(integer, ",") <~ ")") ^^ {
+  def latentItv(implicit conf:Configuration): Parser[UserDefinedConstraint] = ("Latent(" ~> qident ~ "," ~ repsep(integer, ",") <~ ")") ^^ {
     case fm ~ _ ~ itvs => LatentCstr(FailureMode(fm), Some(itvs))
   }
 
   /** Disjunction of user defined constraints */
-  def usrDefCtr: Parser[UserDefinedConstraint] = alloc | coloc | indep | notindep | noneIndep | dalBound | aircraftData | lambdaBounds | latent | latentItv | optimisation | dalRule | maxCost | minCost | DalCost | dalBoundqIdent
+  def usrDefCtr(implicit conf:Configuration): Parser[UserDefinedConstraint] = alloc | coloc | indep | notindep | noneIndep | dalBound | aircraftData | lambdaBounds | latent | latentItv | optimisation | dalRule | maxCost | minCost | DalCost | dalBoundqIdent
 
   /** Rule for user defined constraints file */
-  def usrDefCtrs(c: UserDefinedConstraints): Parser[UserDefinedConstraints] = opt(rep(usrDefCtr | comment)) ^^ {
+  def usrDefCtrs(c: UserDefinedConstraints)(implicit conf:Configuration): Parser[UserDefinedConstraints] = opt(rep(usrDefCtr | comment)) ^^ {
     constraints => {
       if (constraints.isDefined)
         constraints.get collect {case cst:UserDefinedConstraint => cst} foreach c.add
@@ -336,7 +337,7 @@ object ModelParser extends RegexParsers {
   }
 
   /** Loads the given user defined constraints file. */
-  def loadUDef(filename: String, c: UserDefinedConstraints): Unit = {
+  def loadUDef(filename: String, c: UserDefinedConstraints)(implicit conf:Configuration): Unit = {
     val reader = try {
       val reader = new FileReader(filename)
       reader

src/main/scala/dalculator/utils/Configuration.scala

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c)  2023. ONERA
+ * This file is part of Dalculator
+ *
+ * Dalculator is free software ;
+ * you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation ;
+ * either version 2 of  the License, or (at your option) any later version.
+ *
+ * PML Analyzer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY ;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with this program ;
+ *  if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+ */
+
+package dalculator.utils
+
+case class Configuration(
+    printWarning:Boolean
+                        )
+
+object Configuration {
+  val default: Configuration = Configuration(true)
+}

src/main/scala/preprocessor/composer/DALComposer.scala

@@ -21,6 +21,7 @@ import dalculator.cli.DalculatorParameters
 import dalculator.model.DalLevel._
 import dalculator.model._
 import dalculator.solver.SolveDal
+import dalculator.utils.Configuration
 import preprocessor.analysis.AnalysisTypes.{DALAnalysis, FHA, MCSAnalysis, UDEFFile}
 import preprocessor.ast._
 import preprocessor.transformers.Parser
@@ -34,7 +35,7 @@ trait DALComposer[Pre] extends Composer[Pre] {
 
 trait DALComposerInstances {
 
-  implicit def UDEFFileToDALComposer(implicit parser: Parser.Aux[UDEFFile, Map[Item, DalLevel]]): DALComposer[UDEFFile] = new DALComposer[UDEFFile] {
+  implicit def UDEFFileToDALComposer(implicit parser: Parser.Aux[UDEFFile, Map[Item, DalLevel]], conf:Configuration): DALComposer[UDEFFile] = new DALComposer[UDEFFile] {
 
     def apply(pre: UDEFFile): DALAnalysis = DALAnalysis(parser.parse(pre))
   }

src/main/scala/preprocessor/composer/MCSComposer.scala

@@ -18,6 +18,7 @@
 package preprocessor.composer
 
 import dalculator.model.FailureMode
+import dalculator.utils.Configuration
 import preprocessor.analysis.AnalysisTypes._
 import preprocessor.ast.ASTImplicits._
 import preprocessor.ast.FC
@@ -40,7 +41,7 @@ trait MCSComposerInstances {
         .value
   }
 
-  implicit def OCASFileToMCSComposer(implicit parser: Parser.Aux[OCASFile,Option[(FC,List[List[FailureMode]])]]): MCSComposer[List[OCASFile]] = new MCSComposer[List[OCASFile]] {
+  implicit def OCASFileToMCSComposer(implicit parser: Parser.Aux[OCASFile,Option[(FC,List[List[FailureMode]])]], conf:Configuration): MCSComposer[List[OCASFile]] = new MCSComposer[List[OCASFile]] {
 
     def apply(files: List[OCASFile]): MCSAnalysis = MCSAnalysis(files.flatMap(parse).toMap)
 

src/main/scala/preprocessor/composer/MSSComposer.scala

@@ -18,6 +18,7 @@
 package preprocessor.composer
 
 import dalculator.model.FailureMode
+import dalculator.utils.Configuration
 import preprocessor.analysis.AnalysisTypes._
 import preprocessor.ast.ASTImplicits._
 import preprocessor.ast.FC
@@ -33,7 +34,7 @@ trait MSSComposer[Pre] extends Composer [Pre]{
 
 trait MSSComposerInstances {
 
-  implicit def FileToMSSComposer(implicit parser:Parser.Aux[OCASFile,Option[(FC,List[MS])]]): MSSComposer[List[OCASFile]] = new MSSComposer[List[OCASFile]] {
+  implicit def FileToMSSComposer(implicit parser:Parser.Aux[OCASFile,Option[(FC,List[MS])]], conf:Configuration): MSSComposer[List[OCASFile]] = new MSSComposer[List[OCASFile]] {
 
     def apply(files: List[OCASFile]): MSSAnalysis = MSSAnalysis(files.flatMap(parse).toMap)