cookbooks/web/resources/rails_port.rb

   1 #
   2 # Cookbook:: web
   3 # Resource:: rails_port
   4 #
   5 # Copyright:: 2012, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 require "yaml"
  21
  22 resource_name :rails_port
  23 provides :rails_port
  24
  25 default_action :create
  26
  27 property :site, String, :name_property => true
  28 property :ruby, String, :default => "2.3"
  29 property :directory, String
  30 property :user, String
  31 property :group, String
  32 property :repository, String, :default => "https://git.openstreetmap.org/public/rails.git"
  33 property :revision, String, :default => "live"
  34 property :run_migrations, [true, false], :default => false
  35 property :build_assets, [true, false], :default => true
  36 property :email_from, String, :default => "OpenStreetMap <support@openstreetmap.org>"
  37 property :status, String, :default => "online"
  38 property :database_host, String
  39 property :database_port, String
  40 property :database_name, String
  41 property :database_username, String
  42 property :database_password, String
  43 property :email_from, String
  44 property :messages_domain, String
  45 property :gpx_dir, String
  46 property :attachments_dir, String
  47 property :log_path, String
  48 property :logstash_path, String
  49 property :memcache_servers, Array
  50 property :potlatch2_key, String
  51 property :id_key, String
  52 property :oauth_key, String
  53 property :nominatim_url, String
  54 property :osrm_url, String
  55 property :google_auth_id, String
  56 property :google_auth_secret, String
  57 property :google_openid_realm, String
  58 property :facebook_auth_id, String
  59 property :facebook_auth_secret, String
  60 property :windowslive_auth_id, String
  61 property :windowslive_auth_secret, String
  62 property :github_auth_id, String
  63 property :github_auth_secret, String
  64 property :wikipedia_auth_id, String
  65 property :wikipedia_auth_secret, String
  66 property :thunderforest_key, String
  67 property :totp_key, String
  68 property :csp_enforce, [true, false], :default => false
  69 property :csp_report_url, String
  70 property :piwik_configuration, Hash
  71 property :trace_use_job_queue, [true, false], :default => false
  72 property :diary_feed_delay, Integer
  73 property :storage_configuration, Hash, :default => {}
  74 property :storage_service, String, :default => "local"
  75 property :storage_url, String
  76
  77 action :create do
  78   package %W[
  79     ruby#{new_resource.ruby}
  80     ruby#{new_resource.ruby}-dev
  81     imagemagick
  82     nodejs
  83     tzdata
  84   ]
  85
  86   package %w[
  87     g++
  88     pkg-config
  89     libpq-dev
  90     libsasl2-dev
  91     libxml2-dev
  92     libxslt1-dev
  93     libmemcached-dev
  94     libffi-dev
  95     libgd-dev
  96     libarchive-dev
  97     libbz2-dev
  98   ]
  99
 100   package %w[
 101     pngcrush
 102     advancecomp
 103     optipng
 104     pngquant
 105     jhead
 106     jpegoptim
 107     gifsicle
 108     libjpeg-turbo-progs
 109   ]
 110
 111   gem_package "bundler#{new_resource.ruby}" do
 112     package_name "bundler"
 113     version "2.1.4"
 114     gem_binary "gem#{new_resource.ruby}"
 115     options "--format-executable"
 116   end
 117
 118   gem_package "bundler#{new_resource.ruby}" do
 119     package_name "pkg-config"
 120     gem_binary "gem#{new_resource.ruby}"
 121   end
 122
 123   declare_resource :directory, rails_directory do
 124     owner new_resource.user
 125     group new_resource.group
 126     mode "2775"
 127   end
 128
 129   git rails_directory do
 130     action :sync
 131     repository new_resource.repository
 132     revision new_resource.revision
 133     depth 1
 134     user new_resource.user
 135     group new_resource.group
 136     notifies :restart, "passenger_application[#{rails_directory}]"
 137   end
 138
 139   declare_resource :directory, "#{rails_directory}/tmp" do
 140     owner new_resource.user
 141     group new_resource.group
 142   end
 143
 144   file "#{rails_directory}/config/environment.rb" do
 145     owner new_resource.user
 146     group new_resource.group
 147   end
 148
 149   template "#{rails_directory}/config/database.yml" do
 150     cookbook "web"
 151     source "database.yml.erb"
 152     owner new_resource.user
 153     group new_resource.group
 154     mode "664"
 155     variables :host => new_resource.database_host,
 156               :port => new_resource.database_port,
 157               :name => new_resource.database_name,
 158               :username => new_resource.database_username,
 159               :password => new_resource.database_password
 160     notifies :restart, "passenger_application[#{rails_directory}]"
 161   end
 162
 163   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 164     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 165     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 166
 167     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 168
 169     if new_resource.email_from
 170       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 171     end
 172
 173     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 174
 175     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 176
 177     if new_resource.messages_domain
 178       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 179     end
 180
 181     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 182
 183     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"/usr/share/GeoIP/GeoLite2-Country.mmdb\"")
 184
 185     if new_resource.gpx_dir
 186       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 187       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 188     end
 189
 190     if new_resource.attachments_dir
 191       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 192     end
 193
 194     if new_resource.log_path
 195       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 196     end
 197
 198     if new_resource.logstash_path
 199       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 200     end
 201
 202     if new_resource.memcache_servers
 203       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 204     end
 205
 206     if new_resource.potlatch2_key
 207       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 208     end
 209
 210     if new_resource.id_key
 211       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 212     end
 213
 214     if new_resource.oauth_key
 215       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 216     end
 217
 218     if new_resource.nominatim_url
 219       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 220     end
 221
 222     if new_resource.osrm_url
 223       line.gsub!(/^( *)osrm_url:.*$/, "\\1osrm_url: \"#{new_resource.osrm_url}\"")
 224     end
 225
 226     if new_resource.google_auth_id
 227       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 228       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 229       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 230     end
 231
 232     if new_resource.facebook_auth_id
 233       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 234       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 235     end
 236
 237     if new_resource.windowslive_auth_id
 238       line.gsub!(/^( *)#windowslive_auth_id:.*$/, "\\1windowslive_auth_id: \"#{new_resource.windowslive_auth_id}\"")
 239       line.gsub!(/^( *)#windowslive_auth_secret:.*$/, "\\1windowslive_auth_secret: \"#{new_resource.windowslive_auth_secret}\"")
 240     end
 241
 242     if new_resource.github_auth_id
 243       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 244       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 245     end
 246
 247     if new_resource.wikipedia_auth_id
 248       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 249       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 250     end
 251
 252     if new_resource.thunderforest_key
 253       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 254     end
 255
 256     if new_resource.totp_key
 257       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 258     end
 259
 260     if new_resource.csp_enforce
 261       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 262     end
 263
 264     if new_resource.csp_report_url
 265       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 266     end
 267
 268     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 269     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 270     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 271
 272     line
 273   end
 274
 275   file "create:#{rails_directory}/config/application.yml" do
 276     path "#{rails_directory}/config/application.yml"
 277     owner new_resource.user
 278     group new_resource.group
 279     mode "664"
 280     content application_yml
 281     notifies :restart, "passenger_application[#{rails_directory}]"
 282     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 283   end
 284
 285   file "delete:#{rails_directory}/config/application.yml" do
 286     path "#{rails_directory}/config/application.yml"
 287     action :delete
 288     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 289   end
 290
 291   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 292     "email_from",
 293     "status",
 294     "messages_domain",
 295     "attachments_dir",
 296     "log_path",
 297     "logstash_path",
 298     "potlatch2_key",
 299     "id_key",
 300     "oauth_key",
 301     "nominatim_url",
 302     "osrm_url",
 303     "google_auth_id",
 304     "google_auth_secret",
 305     "google_openid_realm",
 306     "facebook_auth_id",
 307     "facebook_auth_secret",
 308     "windowslive_auth_id",
 309     "windowslive_auth_secret",
 310     "github_auth_id",
 311     "github_auth_secret",
 312     "wikipedia_auth_id",
 313     "wikipedia_auth_secret",
 314     "thunderforest_key",
 315     "totp_key",
 316     "csp_enforce",
 317     "csp_report_url",
 318     "trace_use_job_queue",
 319     "diary_feed_delay",
 320     "storage_service",
 321     "storage_url"
 322   ).reject { |_k, v| v.nil? }.merge(
 323     "server_protocol" => "https",
 324     "server_url" => new_resource.site,
 325     "support_email" => "support@openstreetmap.org",
 326     "email_return_path" => "bounces@openstreetmap.org",
 327     "geonames_username" => "openstreetmap",
 328     "maxmind_database" => "/usr/share/GeoIP/GeoLite2-Country.mmdb"
 329   )
 330
 331   if new_resource.memcache_servers
 332     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 333   end
 334
 335   if new_resource.gpx_dir
 336     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 337     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 338   end
 339
 340   file "#{rails_directory}/config/settings.local.yml" do
 341     owner new_resource.user
 342     group new_resource.group
 343     mode "664"
 344     content YAML.dump(settings)
 345     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 346   end
 347
 348   storage_configuration = new_resource.storage_configuration.merge(
 349     "local" => {
 350       "service" => "Disk",
 351       "root" => "#{rails_directory}/storage"
 352     }
 353   )
 354
 355   file "#{rails_directory}/config/storage.yml" do
 356     owner new_resource.user
 357     group new_resource.group
 358     mode "664"
 359     content YAML.dump(storage_configuration)
 360   end
 361
 362   if new_resource.piwik_configuration
 363     file "#{rails_directory}/config/piwik.yml" do
 364       owner new_resource.user
 365       group new_resource.group
 366       mode "664"
 367       content YAML.dump(new_resource.piwik_configuration)
 368     end
 369   else
 370     file "#{rails_directory}/config/piwik.yml" do
 371       action :delete
 372     end
 373   end
 374
 375   execute "#{rails_directory}/Gemfile" do
 376     action :nothing
 377     command "bundle#{new_resource.ruby} install"
 378     cwd rails_directory
 379     user "root"
 380     group "root"
 381     environment "NOKOGIRI_USE_SYSTEM_LIBRARIES" => "yes"
 382     subscribes :run, "gem_package[bundler#{new_resource.ruby}]"
 383     subscribes :run, "git[#{rails_directory}]"
 384     notifies :restart, "passenger_application[#{rails_directory}]"
 385   end
 386
 387   execute "#{rails_directory}/db/migrate" do
 388     action :nothing
 389     command "bundle#{new_resource.ruby} exec rake db:migrate"
 390     cwd rails_directory
 391     user new_resource.user
 392     group new_resource.group
 393     subscribes :run, "git[#{rails_directory}]"
 394     notifies :restart, "passenger_application[#{rails_directory}]"
 395     only_if { new_resource.run_migrations }
 396   end
 397
 398   package "yarnpkg" do
 399     only_if { new_resource.build_assets }
 400   end
 401
 402   execute "#{rails_directory}/package.json" do
 403     action :nothing
 404     command "bundle#{new_resource.ruby} exec rake yarn:install"
 405     environment "HOME" => rails_directory,
 406                 "RAILS_ENV" => "production"
 407     cwd rails_directory
 408     user new_resource.user
 409     group new_resource.group
 410     subscribes :run, "git[#{rails_directory}]"
 411     only_if { new_resource.build_assets }
 412   end
 413
 414   execute "#{rails_directory}/app/assets/javascripts/i18n" do
 415     action :nothing
 416     command "bundle#{new_resource.ruby} exec rake i18n:js:export"
 417     environment "HOME" => rails_directory,
 418                 "RAILS_ENV" => "production"
 419     cwd rails_directory
 420     user new_resource.user
 421     group new_resource.group
 422     subscribes :run, "git[#{rails_directory}]"
 423     only_if { new_resource.build_assets }
 424   end
 425
 426   execute "#{rails_directory}/public/assets" do
 427     action :nothing
 428     command "bundle#{new_resource.ruby} exec rake assets:precompile"
 429     environment "HOME" => rails_directory,
 430                 "RAILS_ENV" => "production"
 431     cwd rails_directory
 432     user new_resource.user
 433     group new_resource.group
 434     subscribes :run, "git[#{rails_directory}]"
 435     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 436     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 437     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 438     subscribes :run, "file[#{rails_directory}/config/piwik.yml]"
 439     subscribes :run, "execute[#{rails_directory}/package.json]"
 440     subscribes :run, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 441     notifies :restart, "passenger_application[#{rails_directory}]"
 442     only_if { new_resource.build_assets }
 443   end
 444
 445   file "#{rails_directory}/public/export/embed.html" do
 446     action :nothing
 447     subscribes :delete, "git[#{rails_directory}]"
 448   end
 449
 450   passenger_application rails_directory do
 451     action :nothing
 452     only_if { ::File.exist?("/usr/bin/passenger-config") }
 453   end
 454
 455   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 456     cookbook "web"
 457     source "rails.cron.erb"
 458     owner "root"
 459     group "root"
 460     mode "755"
 461     variables :directory => rails_directory
 462   end
 463 end
 464
 465 action :restart do
 466   passenger_application rails_directory do
 467     action :restart
 468   end
 469 end
 470
 471 action_class do
 472   include Chef::Mixin::EditFile
 473
 474   def rails_directory
 475     new_resource.directory || "/srv/#{new_resource.site}"
 476   end
 477 end