BiopetCommandLineFunctionTrait.scala 7.72 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
 * Biopet is built on top of GATK Queue for building bioinformatic
 * pipelines. It is mainly intended to support LUMC SHARK cluster which is running
 * SGE. But other types of HPC that are supported by GATK Queue (such as PBS)
 * should also be able to execute Biopet tools and pipelines.
 *
 * Copyright 2014 Sequencing Analysis Support Core - Leiden University Medical Center
 *
 * Contact us at: sasc@lumc.nl
 *
 * A dual licensing mode is applied. The source code within this project that are
 * not part of GATK Queue is freely available for non-commercial use under an AGPL
 * license; For commercial users or users who do not want to follow the AGPL
 * license, please contact us to obtain a separate license.
 */
16
17
18
package nl.lumc.sasc.biopet.core

import java.io.File
Peter van 't Hof's avatar
Peter van 't Hof committed
19
import nl.lumc.sasc.biopet.core.config.Configurable
Peter van 't Hof's avatar
Peter van 't Hof committed
20
21
import org.broadinstitute.gatk.queue.QException
import org.broadinstitute.gatk.queue.function.CommandLineFunction
22
23
import org.broadinstitute.gatk.utils.commandline.{ Input, Argument }
import scala.sys.process.{ Process, ProcessLogger }
24
import scala.util.matching.Regex
25
26
import java.io.FileInputStream
import java.security.MessageDigest
27

Peter van 't Hof's avatar
Peter van 't Hof committed
28
29
30
/**
 * Biopet command line trait to auto check executable and cluster values
 */
31
trait BiopetCommandLineFunctionTrait extends CommandLineFunction with Configurable {
Peter van 't Hof's avatar
Peter van 't Hof committed
32
  analysisName = configName
bow's avatar
bow committed
33
34

  @Input(doc = "deps", required = false)
35
  var deps: List[File] = Nil
bow's avatar
bow committed
36

37
38
  var threads = 0
  val defaultThreads = 1
bow's avatar
bow committed
39

Peter van 't Hof's avatar
Peter van 't Hof committed
40
  var vmem: Option[String] = None
41
  val defaultVmem: String = ""
Peter van 't Hof's avatar
Peter van 't Hof committed
42
  var executable: String = _
bow's avatar
bow committed
43

Peter van 't Hof's avatar
Peter van 't Hof committed
44
45
46
47
  /**
   * Can override this method. This is executed just before the job is ready to run.
   * Can check on run time files from pipeline here
   */
Peter van 't Hof's avatar
Peter van 't Hof committed
48
  protected[core] def beforeCmd {}
Peter van 't Hof's avatar
Peter van 't Hof committed
49
50

  /**
Peter van 't Hof's avatar
Peter van 't Hof committed
51
52
   * Can overr
   * ide this method. This is executed after the script is done en queue starts to generate the graph
Peter van 't Hof's avatar
Peter van 't Hof committed
53
   */
54
  protected[core] def beforeGraph {}
Peter van 't Hof's avatar
Peter van 't Hof committed
55
56
57
58

  /**
   * Set default output file, threads and vmem for current job
   */
59
  override def freezeFieldValues() {
60
    preProcesExecutable
61
    beforeGraph
62
    if (jobOutputFile == null) jobOutputFile = new File(firstOutput.getParent + "/." + firstOutput.getName + "." + configName + ".out")
bow's avatar
bow committed
63

64
65
    if (threads == 0) threads = getThreads(defaultThreads)
    if (threads > 1) nCoresRequest = Option(threads)
bow's avatar
bow committed
66

Peter van 't Hof's avatar
Peter van 't Hof committed
67
    if (vmem.isEmpty) {
Peter van 't Hof's avatar
Peter van 't Hof committed
68
      vmem = config("vmem")
69
      if (vmem.isEmpty && defaultVmem.nonEmpty) vmem = Some(defaultVmem)
70
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
71
    if (vmem.isDefined) jobResourceRequests :+= "h_vmem=" + vmem.get
72
    jobName = configName + ":" + (if (firstOutput != null) firstOutput.getName else jobOutputFile)
bow's avatar
bow committed
73

74
75
    super.freezeFieldValues()
  }
bow's avatar
bow committed
76

Peter van 't Hof's avatar
Peter van 't Hof committed
77
78
79
  /**
   * Checks executable. Follow full CanonicalPath, checks if it is existing and do a md5sum on it to store in job report
   */
80
  protected[core] def preProcesExecutable {
81
82
83
84
85
86
87
88
89
90
91
92
    if (!BiopetCommandLineFunctionTrait.executableMd5Cache.contains(executable)) {
      try if (executable != null) {
        if (!BiopetCommandLineFunctionTrait.executableCache.contains(executable)) {
          val oldExecutable = executable
          val buffer = new StringBuffer()
          val cmd = Seq("which", executable)
          val process = Process(cmd).run(ProcessLogger(buffer.append(_)))
          if (process.exitValue == 0) {
            executable = buffer.toString
            val file = new File(executable)
            executable = file.getCanonicalPath
          } else {
93
            BiopetQScript.addError("executable: '" + executable + "' not found, please check config")
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
          }
          BiopetCommandLineFunctionTrait.executableCache += oldExecutable -> executable
          BiopetCommandLineFunctionTrait.executableCache += executable -> executable
        } else {
          executable = BiopetCommandLineFunctionTrait.executableCache(executable)
        }

        if (!BiopetCommandLineFunctionTrait.executableMd5Cache.contains(executable)) {
          val is = new FileInputStream(executable)
          val cnt = is.available
          val bytes = Array.ofDim[Byte](cnt)
          is.read(bytes)
          is.close()
          val temp = MessageDigest.getInstance("MD5").digest(bytes).map("%02X".format(_)).mkString.toLowerCase
          BiopetCommandLineFunctionTrait.executableMd5Cache += executable -> temp
        }
      } catch {
        case ioe: java.io.IOException => logger.warn("Could not use 'which', check on executable skipped: " + ioe)
112
113
      }
    }
114
115
    val md5 = BiopetCommandLineFunctionTrait.executableMd5Cache.get(executable)
    addJobReportBinding("md5sum_exe", md5.getOrElse("None"))
116
  }
bow's avatar
bow committed
117

Peter van 't Hof's avatar
Peter van 't Hof committed
118
119
120
  /**
   * executes checkExecutable method and fill job report
   */
121
  final protected def preCmdInternal {
122
    preProcesExecutable
bow's avatar
bow committed
123

124
    beforeCmd
bow's avatar
bow committed
125

Peter van 't Hof's avatar
Peter van 't Hof committed
126
127
    addJobReportBinding("cores", nCoresRequest match {
      case Some(n) if n > 0 => n
128
      case _                => 1
Peter van 't Hof's avatar
Peter van 't Hof committed
129
    })
130
    addJobReportBinding("version", getVersion)
131
  }
bow's avatar
bow committed
132

Peter van 't Hof's avatar
Peter van 't Hof committed
133
134
135
136
  /**
   * Command to get version of executable
   * @return
   */
137
  protected def versionCommand: String = null
Peter van 't Hof's avatar
Peter van 't Hof committed
138
139

  /** Regex to get version from version command output */
140
  protected val versionRegex: Regex = null
Peter van 't Hof's avatar
Peter van 't Hof committed
141
142
143
144
145

  /** Allowed exit codes for the version command */
  protected val versionExitcode = List(0)

  /** Executes the version command */
Peter van 't Hof's avatar
Peter van 't Hof committed
146
  private def getVersionInternal: String = {
147
    if (versionCommand == null || versionRegex == null) return "N/A"
148
    val exe = new File(versionCommand.trim.split(" ")(0))
Peter van 't Hof's avatar
Peter van 't Hof committed
149
    if (!exe.exists()) return "N/A"
150
151
    val stdout = new StringBuffer()
    val stderr = new StringBuffer()
152
153
154
155
    def outputLog = "Version command: \n" + versionCommand +
      "\n output log: \n stdout: \n" + stdout.toString +
      "\n stderr: \n" + stderr.toString
    val process = Process(versionCommand).run(ProcessLogger(stdout append _ + "\n", stderr append _ + "\n"))
156
    if (!versionExitcode.contains(process.exitValue)) {
157
      logger.warn("getVersion give exit code " + process.exitValue + ", version not found \n" + outputLog)
158
159
      return "N/A"
    }
160
    for (line <- stdout.toString.split("\n") ++ stderr.toString.split("\n")) {
bow's avatar
bow committed
161
      line match {
162
        case versionRegex(m) => return m
Peter van 't Hof's avatar
Peter van 't Hof committed
163
        case _               =>
164
165
      }
    }
166
    logger.warn("getVersion give a exit code " + process.exitValue + " but no version was found, executable correct? \n" + outputLog)
167
168
    return "N/A"
  }
bow's avatar
bow committed
169

Peter van 't Hof's avatar
Peter van 't Hof committed
170
  /** Get version from cache otherwise execute the version command  */
Peter van 't Hof's avatar
Peter van 't Hof committed
171
  def getVersion: String = {
Peter van 't Hof's avatar
Peter van 't Hof committed
172
    if (!BiopetCommandLineFunctionTrait.executableCache.contains(executable))
173
      preProcesExecutable
Peter van 't Hof's avatar
Peter van 't Hof committed
174
175
176
177
178
    if (!BiopetCommandLineFunctionTrait.versionCache.contains(executable))
      BiopetCommandLineFunctionTrait.versionCache += executable -> getVersionInternal
    return BiopetCommandLineFunctionTrait.versionCache(executable)
  }

Peter van 't Hof's avatar
Peter van 't Hof committed
179
180
181
182
183
  /**
   * Get threads from config
   * @param default default when not found in config
   * @return number of threads
   */
bow's avatar
bow committed
184
185
186
  def getThreads(default: Int): Int = {
    val maxThreads: Int = config("maxthreads", default = 8)
    val threads: Int = config("threads", default = default)
187
188
189
    if (maxThreads > threads) return threads
    else return maxThreads
  }
bow's avatar
bow committed
190

Peter van 't Hof's avatar
Peter van 't Hof committed
191
192
193
194
195
196
  /**
   * Get threads from config
   * @param default default when not found in config
   * @param module Module when this is difrent from default
   * @return number of threads
   */
bow's avatar
bow committed
197
198
199
  def getThreads(default: Int, module: String): Int = {
    val maxThreads: Int = config("maxthreads", default = 8, submodule = module)
    val threads: Int = config("threads", default = default, submodule = module)
200
201
202
203
    if (maxThreads > threads) return threads
    else return maxThreads
  }
}
Peter van 't Hof's avatar
Peter van 't Hof committed
204

Peter van 't Hof's avatar
Peter van 't Hof committed
205
206
207
/**
 * stores global caches
 */
Peter van 't Hof's avatar
Peter van 't Hof committed
208
209
210
object BiopetCommandLineFunctionTrait {
  import scala.collection.mutable.Map
  private val versionCache: Map[String, String] = Map()
211
212
  private val executableMd5Cache: Map[String, String] = Map()
  private val executableCache: Map[String, String] = Map()
213
}