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