-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
file_template.rb
143 lines (121 loc) · 4.87 KB
/
file_template.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# Copyright 2017 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'fileutils'
require 'google/logger'
require 'pathname'
module Provider
# Parent class for specific types of files. Contains methods to generate files
class FileTemplate
include Compile::Core
# The root folder we're outputting to.
attr_accessor :output_folder
# Information about the local environment
# (which formatters are enabled, start-time)
attr_accessor :env
# The API version
attr_accessor :version
# Given the data object for a file, write that file and verify that it
# passes these conditions:
#
# - The file has not been generated already this run
# - The file has an autogen exception or an autogen notice defined
#
# Once the file's contents are written, set the proper [chmod] mode and
# format the file with a language-appropriate formatter.
def generate(pwd, template, path, provider)
# You're looking at some magic here!
# This is how variables are made available in templates; we iterate
# through each key:value pair in this object, and we set them
# in the scope of the provider.
#
# The templates get access to everything in the provider +
# all of the variables in this object.
ctx = provider.provider_binding
instance_variables.each do |name|
ctx.local_variable_set(name[1..], instance_variable_get(name))
end
ctx.local_variable_set('pwd', pwd)
ctx.local_variable_set('hc_downstream', provider.generating_hashicorp_repo?)
# check if the parent folder exists, and make it if not
parent_path = File.dirname(path)
FileUtils.mkdir_p(parent_path) unless File.directory?(parent_path)
Google::LOGGER.debug "Generating #{path}"
File.open(path, 'w') { |f| f.puts compile_file(ctx, "#{pwd}/#{template}") }
# Files are often generated in parallel.
# We can use thread-local variables to ensure that autogen checking
# stays specific to the file each thred represents.
raise "#{path} missing autogen" unless Thread.current[:autogen]
old_file_chmod_mode = File.stat("#{pwd}/#{template}").mode
FileUtils.chmod(old_file_chmod_mode, path)
format_output_file(path, template)
end
private
# path is the output name of the file
# template is used to determine metadata about the file based on how it is
# generated
def format_output_file(path, template)
return unless path.end_with?('.go') && @env[:goformat_enabled]
run_formatter("gofmt -w -s #{path}")
run_formatter("goimports -w #{path}") unless template.include?('third_party/terraform')
end
def run_formatter(command)
output = %x(#{command} 2>&1)
Google::LOGGER.error output unless $CHILD_STATUS.to_i.zero?
end
def relative_path(target, base)
Pathname.new(target).relative_path_from(Pathname.new(base))
end
end
# Responsible for compiling provider-level files, rather than product-specific ones
class ProviderFileTemplate < Provider::FileTemplate
# All the products that are being compiled with the provider on this run
attr_accessor :products
# Optional path to the directory where overrides reside. Used to locate files
# outside of the MM root directory
attr_accessor :override_path
def initialize(output_folder, version, env, products, override_path = nil)
super()
@output_folder = output_folder
@version = version
@env = env
@products = products
@override_path = override_path
end
end
# Responsible for generating a file in the context of a product
# with a given set of parameters.
class ProductFileTemplate < Provider::FileTemplate
# The name of the resource
attr_accessor :name
# The resource itself.
attr_accessor :object
# The entire API object.
attr_accessor :product
class << self
# Construct a new ProductFileTemplate based on a resource object
def file_for_resource(output_folder, object, version, env)
file_template = new(output_folder, object.name, object.__product, version, env)
file_template.object = object
file_template
end
end
def initialize(output_folder, name, product, version, env)
super()
@name = name
@product = product
@output_folder = output_folder
@version = version
@env = env
end
end
end