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