Merge pull request #103 from OSC/feature/vray-support

Feature/vray support

Author: johrstrom

README.md

@@ -162,6 +162,8 @@ for convenience. For more information see
 
 ## Additional Options
 
+### Maya Additional Options
+
 The default given is `-verb -b 1 -ai:lve 0`.  Here's a breakdown of what those flags mean:
 
 * `-verb` Print Mel commands before they are executed
@@ -177,6 +179,12 @@ of each other.
 To view all of the possible arguments see [this page](/docs/mds/ARNOLD.md) for the Arnold renderer. Flags for
 other renderers are not documented here, but could be if requested.
 
+### VRay Additional Options
+
+The default for VRay is `-verbose=3` which is the default log output level.
+
+See [the VRAY help page](/docs/mds/VRAY.md) for all the available flags you can use here.
+
 ## Running Maya UI in a VDI
 
 It's possible for users to run the AutoDesk Maya UI through a virtual deskop application in OpenOndemand (VDI).
@@ -214,12 +222,12 @@ OOD_FRAME_RENDERER_CLUSTER=owens
 # defaults to 28 which, on owens, is an entire node.
 OOD_FRAME_RENDERER_CORES=28
 
-# The job script that will be templated and submitted.  The template language is
+# The maya job script that will be templated and submitted.  The template language is
 # Ruby's ERB.  All the variables in the default script will be available to any
 # new script file.
 #
 # defaults to the script template included with this source (relative directory)
-OOD_FRAME_RENDERER_SCRIPT='jobs/video_jobs/maya_submit.sh.erb'
+OOD_FRAME_RENDERER_MAYA_SCRIPT='jobs/video_jobs/maya_submit.sh.erb'
 ```
 
 ## Developer Guide

app/controllers/projects_controller.rb

@@ -15,9 +15,13 @@ def show
   end
 
   def create
-    @project = Project.new(project_params)
-    @project.save
-    redirect_to @project
+    @project = ProjectFactory.new_project(project_params)
+    if @project.save
+      redirect_to @project
+    else
+      # TODO: show these errors in the webpage.
+      Rails.logger.info("could not save project becuase #{@project.errors.full_messages}")
+    end
   end
 
   def edit
@@ -43,6 +47,6 @@ def destroy
   def project_params
     params
       .require(:project)
-      .permit(:name, :description, :directory)
+      .permit(:name, :description, :directory, :project_type)
   end
 end

app/controllers/scripts_controller.rb

@@ -2,12 +2,17 @@ class ScriptsController < ApplicationController
 
   def new
     @project = Project.find(params[:project_id])
-    init_script
+    @script = default_script
   end
 
   def create
     @project = Project.find(params[:project_id])
-    @script = @project.scripts.build(script_params)
+
+    if ProjectFactory.vray_project?(@project)
+      @script = @project.scripts.build(script_params.merge({ type: 'VRayScript' }))
+    else
+      @script = @project.scripts.build(script_params.merge({ type: 'MayaScript' }))
+    end
 
     if @script.save
       redirect_to project_path(@project), notice: 'Job settings successfully created.'
@@ -54,7 +59,7 @@ def submit
       redirect_to @project, alert: @script.errors[:name].first
     end
   end
-  
+
   def show
     @project = Project.find(params[:project_id])
     @script = Script.find(params[:id])
@@ -108,24 +113,22 @@ def get_jobs(params)
     @jobs = @script.jobs.where(script_id: params[:script_id])
   end
 
-  def init_script 
-    @script = @project.scripts.build(
-      file: @project.directory,
-      extra: '-verb -b 1 -ai:lve 0',
+  def default_script
+    @project.scripts.build(
       email: true,
       walltime: 1,
-      cluster: Script.default_cluster,
-      skip_existing: true
+      skip_existing: true,
+      extra: @project.default_script_extra,
+      type: @project.script_type
     )
-
   end
 
   def script_params
     params
       .require(:script)
       .permit(
         :name, :frames, :camera, :file, :accounting_id, :cluster, :nodes,
-        :renderer, :extra, :walltime, :email, :skip_existing
+        :renderer, :extra, :walltime, :email, :skip_existing, :version
       )
   end
 

app/helpers/scripts_helper.rb

@@ -1,5 +1,17 @@
+# frozen_string_literal: true
+
 module ScriptsHelper
   def normalize_css_str(str)
     str.to_s.sub(' ', '-')
   end
+
+  def version_label(project)
+    if ProjectFactory.maya_project?(project)
+      'Maya'
+    elsif ProjectFactory.vray_project?(project)
+      'VRay'
+    else
+      'Maya'
+    end
+  end
 end

app/models/maya_project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Project subclass for Maya Projects
+class MayaProject < Project
+  def self.model_name
+    Project.model_name
+  end
+
+  def scenes
+    Dir.glob("#{directory}/scenes/**/**.m[ab]")
+  end
+
+  def script_type
+    'MayaScript'
+  end
+
+  def default_script_extra
+    '-verb -b 1 -ai:lve 0'
+  end
+end

app/models/maya_script.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Script subclass for Maya rendering
+class MayaScript < Script
+  def self.model_name
+    Script.model_name
+  end
+
+  def script_template
+    Configuration.maya_script_template
+  end
+
+  def renderers
+    [
+      'arnold', 'default', 'file', 'hw2', 'hw',
+      'interBatch', 'sw', 'turtle', 'turtlebake', 'vr'
+    ].freeze
+  end
+
+  def cores
+    Configuration.cores
+  end
+
+  def cluster
+    Configuration.submit_cluster
+  end
+
+  def available_versions
+    ['2020', '2022']
+  end
+
+  def job_name
+    'maya-render'
+  end
+end

app/models/project.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
+# Project class is meant to be subclassed for specific functionality
 class Project < ApplicationRecord
   validates :name, presence: true, length: { minimum: 5 }, uniqueness: true
-  validates :directory, presence: true 
+  validates :directory, presence: true
   validate :directory_must_be_valid
   validates_uniqueness_of :name
   has_many :scripts
@@ -10,28 +13,20 @@ class Project < ApplicationRecord
   # don't remove attributes from this list going forward! only deprecate
   store :project_attrs, coder: JSON, accessors: %i[]
 
-  class << self
-    def maya_top_level_dir
-      dir = "#{Dir.home}/maya/projects/."
-      FileUtils.mkdir_p dir unless Dir.exist? dir
-      dir
-    end
-  end
+  # we use `project_type` to allow for the form to set this attr and use _it_
+  # to determine the `type` which will instantiate subclasses.
+  attr_accessor :project_type
 
-  
-  def directory_must_be_valid
-    unless Dir.exist? directory
-      errors.add(:directory, "the directory must be valid")
-    end
-  end
+  self.inheritance_column = :type
 
-  def initialize(params = {})
-    super
-    write_attribute(:directory, params.to_h[:directory] ||= Project.maya_top_level_dir)
+  def directory_must_be_valid
+    errors.add(:directory, 'the directory must be valid') unless Dir.exist? directory
   end
 
-  def scenes
-    Dir.glob(directory + '/scenes/**/**.m[ab]')
+  # subclasses should override this. It's kind of an awkward place to put this
+  # knowledge of where the default Script.extra should be, but a script is tied
+  # to a project so, it's the best place for now.
+  def default_script_extra
+    ''
   end
-
 end

app/models/project_factory.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# ProjectFactory creates subclasses of Project
+class ProjectFactory
+  def self.new_project(params)
+    case params[:project_type].to_s.downcase
+    when 'maya'
+      MayaProject.new(params.except(:project_type))
+    when 'vray'
+      VRayProject.new(params.except(:project_type))
+    else
+      MayaProject.new(params.except(:project_type))
+    end
+  end
+
+  def self.maya_project?(project)
+    project.is_a?(MayaProject)
+  end
+
+  def self.vray_project?(project)
+    project.is_a?(VRayProject)
+  end
+end

app/models/script.rb

@@ -4,6 +4,7 @@ class Script < ApplicationRecord
   belongs_to :project
   has_many :jobs, dependent: :destroy
   validates :frames, presence: true, format: { with: /\d+\-\d+/ }
+  self.inheritance_column = :type
 
   # add accessors: [ :attr1, :attr2 ] etc. when you want to add getters and
   # setters to add new attributes stored in the JSON store
@@ -17,10 +18,6 @@ def never_submitted_status
       'not submitted'
     end
 
-    def default_cluster
-      Configuration.submit_cluster
-    end
-
     def batch_jobs_dir
       'batch_jobs'
     end
@@ -60,7 +57,33 @@ def latest_id
   end
 
   def cores
-    Configuration.cores
+    raise 'Subclasses need to define `cores`'
+  end
+
+  def cluster
+    raise 'Subclasses need to define `cluster`'
+  end
+
+  def script_template
+    raise 'Subclasses need to define `script_template`'
+  end
+
+  def renderers
+    raise 'Subclasses need to define `renderers`'
+  end
+
+  def job_name
+    raise 'Subclasses need to define `job_name`'
+  end
+
+  def available_versions
+    raise 'Subclasses need to define `versions_available`'
+  end
+
+  # shell scripts files need to use this method so that we keep backward compatability
+  # with jobs that never set versions.
+  def module_version
+    version.to_s.present? ? version : available_versions.first
   end
 
   def task_start_frames
@@ -106,10 +129,6 @@ def job_sub_dir
     @job_sub_dir ||= Time.now.to_i.to_s
   end
 
-  def script_template
-    Configuration.script_template
-  end
-
   def base_output_dir
     Pathname.new(project_dir).join('batch_jobs').tap { |p| p.mkpath unless p.exist? }
   end
@@ -127,7 +146,7 @@ def new_job
   end
 
   def templated_content
-    erb = ERB.new(File.read(script_template))
+    erb = ERB.new(File.read(script_template), nil, '-')
     erb.filename = script_template.to_s
     erb.result(binding)
   end
@@ -138,7 +157,7 @@ def job_array_request
 
   def job_opts
     {
-      job_name: 'maya-render',
+      job_name: job_name,
       email_on_terminated: email,
       job_array_request: job_array_request,
       workdir: job_dir,

app/models/v_ray_project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Project subclass for Vray Projects
+class VRayProject < Project
+  def self.model_name
+    Project.model_name
+  end
+
+  def scenes
+    Dir.glob("#{directory}/scenes/**/**.vrscene")
+  end
+
+  def script_type
+    'VRayScript'
+  end
+
+  def default_script_extra
+    '-verboseLevel=3'
+  end
+end