Class: OpenStudio::Workflow::Adapters::Mongo

Inherits:
OpenStudio::Workflow::Adapter show all
Defined in:
lib/openstudio/workflow/adapters/mongo.rb

Instance Attribute Summary collapse

Attributes inherited from OpenStudio::Workflow::Adapter

#options

Instance Method Summary collapse

Methods inherited from OpenStudio::Workflow::Adapter

#add_directory_to_zip, #load

Constructor Details

#initialize(options = {}) ⇒ Mongo

Returns a new instance of Mongo.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 40

def initialize(options = {})
  super

  require 'mongoid'
  require 'mongoid_paperclip'
  require 'delayed_job_mongoid'
  base_path = @options[:mongoid_path] ? @options[:mongoid_path] : "#{File.dirname(__FILE__)}/mongo"

  Dir["#{base_path}/models/*.rb"].each { |f| require f }
  Mongoid.load!("#{base_path}/mongoid.yml", :development)
end

Instance Attribute Details

#datapoint ⇒ Object (readonly)

Returns the value of attribute datapoint.



38
39
40
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 38

def datapoint
  @datapoint
end

Instance Method Details

#communicate_complete(_directory) ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 177

def communicate_complete(_directory)
  @datapoint.run_end_time = ::Time.now
  @datapoint.status = 'completed'
  @datapoint.status_message = 'completed normal'
  @datapoint.save!
end

#communicate_failure(directory) ⇒ Object

Final state of the simulation. The os_directory is the run directory and may be needed to zip up the results of the simuation.



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 186

def communicate_failure(directory)
  # zip up the folder even on datapoint failures
  if directory && File.exist?(directory)
    zip_results(directory)
  end

  @datapoint.run_end_time = ::Time.now
  @datapoint.status = 'completed'
  @datapoint.status_message = 'datapoint failure'
  @datapoint.save!
end

#communicate_intermediate_result(_directory) ⇒ Object 



173
174
175
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 173

def communicate_intermediate_result(_directory)
  # noop
end

#communicate_results(directory, results) ⇒ Object 



198
199
200
201
202
203
204
205
206
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 198

def communicate_results(directory, results)
  zip_results(directory)

  # @logger.info 'Saving EnergyPlus JSON file'
  if results
    @datapoint.results ? @datapoint.results.merge!(results) : @datapoint.results = results
  end
  result = @datapoint.save! # redundant because next method calls save too.
end

#communicate_started(directory, options = {}) ⇒ Object

Tell the system that the process has started



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 53

def communicate_started(directory, options = {})
  # Watch out for namespace conflicts (::Time is okay but Time is OpenStudio::Time)
  File.open("#{directory}/started.job", 'w') { |f| f << "Started Workflow #{::Time.now}" }

  @datapoint ||= get_datapoint_model(options[:datapoint_id])
  @datapoint.status = 'started'
  @datapoint.status_message = ''
  @datapoint.run_start_time = ::Time.now

  # TODO: use the ComputeNode model to pull out the information so that we can reuse the methods
  # Determine what the IP address is of the worker node and save in the data point

  # ami-id: ami-7c7e4e14
  # instance-id: i-c52e0412
  # instance-type: m3.medium
  # local-hostname: ip-10-99-169-57.ec2.internal
  # local-ipv4: 10.99.169.57
  # placement: us-east-1a
  # public-hostname: ec2-54-161-221-129.compute-1.amazonaws.com
  # public-ipv4: 54.161.221.129
  # number_of_cores: 1
  if File.exist? '/etc/openstudio-server/instance.yml'
    y = YAML.load_file('/etc/openstudio-server/instance.yml')
    @datapoint.ip_address = y['public-ipv4'] if y['public-ipv4']
    @datapoint.internal_ip_address = y['local-ipv4'] if y['local-ipv4']
  else
    # try to infer it from the socket/facter information
    # note, facter will be deprecated in the future, so don't extend it!
    retries = 0
    begin
      require 'socket'
      if Socket.gethostname =~ /os-.*/
        # Maybe use this in the future: /sbin/ifconfig eth1|grep inet|head -1|sed 's/\:/ /'|awk '{print $3}'
        # Must be on vagrant and just use the hostname to do a lookup
        map = {
          'os-server' => '192.168.33.10',
          'os-worker-1' => '192.168.33.11',
          'os-worker-2' => '192.168.33.12'
        }
        @datapoint.ip_address = map[Socket.gethostname]
        @datapoint.internal_ip_address = @datapoint.ip_address
      else
        if Gem.loaded_specs['facter']
          # Use EC2 public to check if we are on AWS.
          @datapoint.ip_address = Facter.fact(:ec2_public_ipv4) ? Facter.fact(:ec2_public_ipv4).value : Facter.fact(:ipaddress).value
          @datapoint.internal_ip_address = Facter.fact(:ipaddress).value
        end
      end
    rescue => e
      # catch any exceptions. It appears that if a new instance of amazon starts, then it is likely that
      # the Facter for AWS may not be initialized yet. Retry after waiting for 15 seconds if this happens.
      # If this fails out, then the only issue with this is that the data point won't be downloaded because
      # the worker node is not known

      # retry just in case
      if retries < 30 # try for up to 5 minutes
        retries += 1
        sleep 10
        retry
      else
        raise "could not find Facter based data for worker node after #{retries} retries with message #{e.message}"
        # just do nothing for now
      end
    end
  end

  @datapoint.save!
end

#get_datapoint(directory, options = {}) ⇒ Object

Get the data point from the path



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 123

def get_datapoint(directory, options = {})
  # TODO : make this a conditional on when to create one vs when to error out.
  # keep @datapoint as the model instance
  @datapoint = DataPoint.find_or_create_by(uuid: options[:datapoint_id])

  # convert to JSON for the workflow - and rearrange the version (fix THIS)
  datapoint_hash = {}
  if @datapoint.nil?
    fail 'Could not find datapoint'
  else
    datapoint_hash[:data_point] = @datapoint.as_document.to_hash
    # TODO: Can i remove this openstudio_version stuff?
    # datapoint_hash[:openstudio_version] = datapoint_hash[:openstudio_version]

    # TODO: need to figure out how to get symbols from mongo.
    datapoint_hash = MultiJson.load(MultiJson.dump(datapoint_hash), symbolize_keys: true)

    # save to disk for inspection
    save_dp = File.join(directory, 'data_point.json')
    FileUtils.rm_f save_dp if File.exist? save_dp
    File.open(save_dp, 'w') { |f| f << MultiJson.dump(datapoint_hash, pretty: true) }
  end

  datapoint_hash
end

#get_logger(directory, options = {}) ⇒ Object

TODO: Implement the writing to the mongo_db for logging



209
210
211
212
213
214
215
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 209

def get_logger(directory, options = {})
  # get the datapoint object
  get_datapoint(directory, options) unless @datapoint
  @log = OpenStudio::Workflow::Adapters::MongoLog.new(@datapoint)

  @log
end

#get_problem(directory, options = {}) ⇒ Object

TODO: cleanup these options. Make them part of the class. They are just unwieldly here.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/openstudio/workflow/adapters/mongo.rb', line 150

def get_problem(directory, options = {})
  defaults = { format: 'json' }
  options = defaults.merge(options)

  get_datapoint(directory, options) unless @datapoint

  if @datapoint
    analysis = @datapoint.analysis.as_document.to_hash
  else
    fail 'Cannot retrieve problem because datapoint was nil'
  end

  analysis_hash = {}
  if analysis
    analysis_hash[:analysis] = analysis
    analysis_hash[:openstudio_version] = analysis[:openstudio_version]

    # TODO: need to figure out how to get symbols from mongo.
    analysis_hash = MultiJson.load(MultiJson.dump(analysis_hash, pretty: true), symbolize_keys: true)
  end
  analysis_hash
end