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 :google_auth_id, String
  58 property :google_auth_secret, String
  59 property :google_openid_realm, String
  60 property :facebook_auth_id, String
  61 property :facebook_auth_secret, String
  62 property :windowslive_auth_id, String
  63 property :windowslive_auth_secret, String
  64 property :github_auth_id, String
  65 property :github_auth_secret, String
  66 property :wikipedia_auth_id, String
  67 property :wikipedia_auth_secret, String
  68 property :thunderforest_key, String
  69 property :totp_key, String
  70 property :csp_enforce, [true, false], :default => false
  71 property :csp_report_url, String
  72 property :piwik_configuration, Hash
  73 property :trace_use_job_queue, [true, false], :default => false
  74 property :diary_feed_delay, Integer
  75 property :storage_configuration, Hash, :default => {}
  76 property :storage_service, String, :default => "local"
  77 property :storage_url, String
  78 property :tile_cdn_url, String
  79
  80 action :create do
  81   package %W[
  82     ruby#{new_resource.ruby}
  83     ruby#{new_resource.ruby}-dev
  84     imagemagick
  85     nodejs
  86     tzdata
  87   ]
  88
  89   package %w[
  90     g++
  91     make
  92     pkg-config
  93     libpq-dev
  94     libsasl2-dev
  95     libxml2-dev
  96     libxslt1-dev
  97     libmemcached-dev
  98     libffi-dev
  99     libgd-dev
 100     libarchive-dev
 101     libbz2-dev
 102   ]
 103
 104   package %w[
 105     pngcrush
 106     advancecomp
 107     optipng
 108     pngquant
 109     jhead
 110     jpegoptim
 111     gifsicle
 112     libjpeg-turbo-progs
 113   ]
 114
 115   gem_package "bundler#{new_resource.ruby}" do
 116     package_name "bundler"
 117     version "2.1.4"
 118     gem_binary "gem#{new_resource.ruby}"
 119     options "--format-executable"
 120   end
 121
 122   gem_package "bundler#{new_resource.ruby}" do
 123     package_name "pkg-config"
 124     gem_binary "gem#{new_resource.ruby}"
 125   end
 126
 127   declare_resource :directory, rails_directory do
 128     owner new_resource.user
 129     group new_resource.group
 130     mode "2775"
 131   end
 132
 133   git rails_directory do
 134     action :sync
 135     repository new_resource.repository
 136     revision new_resource.revision
 137     depth 1
 138     user new_resource.user
 139     group new_resource.group
 140   end
 141
 142   declare_resource :directory, "#{rails_directory}/tmp" do
 143     owner new_resource.user
 144     group new_resource.group
 145   end
 146
 147   file "#{rails_directory}/config/environment.rb" do
 148     owner new_resource.user
 149     group new_resource.group
 150   end
 151
 152   template "#{rails_directory}/config/database.yml" do
 153     cookbook "web"
 154     source "database.yml.erb"
 155     owner new_resource.user
 156     group new_resource.group
 157     mode "664"
 158     variables :host => new_resource.database_host,
 159               :port => new_resource.database_port,
 160               :name => new_resource.database_name,
 161               :username => new_resource.database_username,
 162               :password => new_resource.database_password
 163   end
 164
 165   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 166     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 167     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 168
 169     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 170
 171     if new_resource.email_from
 172       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 173     end
 174
 175     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 176
 177     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 178
 179     if new_resource.messages_domain
 180       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 181     end
 182
 183     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 184
 185     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"/usr/share/GeoIP/GeoLite2-Country.mmdb\"")
 186
 187     if new_resource.gpx_dir
 188       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 189       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 190     end
 191
 192     if new_resource.attachments_dir
 193       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 194     end
 195
 196     if new_resource.log_path
 197       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 198     end
 199
 200     if new_resource.logstash_path
 201       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 202     end
 203
 204     if new_resource.memcache_servers
 205       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 206     end
 207
 208     if new_resource.potlatch2_key
 209       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 210     end
 211
 212     if new_resource.id_key
 213       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 214     end
 215
 216     if new_resource.oauth_key
 217       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 218     end
 219
 220     if new_resource.oauth_application
 221       line.gsub!(/^( *)#oauth_application:.*$/, "\\1oauth_application: \"#{new_resource.oauth_application}\"")
 222     end
 223
 224     if new_resource.nominatim_url
 225       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 226     end
 227
 228     if new_resource.google_auth_id
 229       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 230       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 231       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 232     end
 233
 234     if new_resource.facebook_auth_id
 235       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 236       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 237     end
 238
 239     if new_resource.windowslive_auth_id
 240       line.gsub!(/^( *)#windowslive_auth_id:.*$/, "\\1windowslive_auth_id: \"#{new_resource.windowslive_auth_id}\"")
 241       line.gsub!(/^( *)#windowslive_auth_secret:.*$/, "\\1windowslive_auth_secret: \"#{new_resource.windowslive_auth_secret}\"")
 242     end
 243
 244     if new_resource.github_auth_id
 245       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 246       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 247     end
 248
 249     if new_resource.wikipedia_auth_id
 250       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 251       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 252     end
 253
 254     if new_resource.thunderforest_key
 255       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 256     end
 257
 258     if new_resource.totp_key
 259       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 260     end
 261
 262     if new_resource.csp_enforce
 263       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 264     end
 265
 266     if new_resource.csp_report_url
 267       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 268     end
 269
 270     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 271     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 272     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 273
 274     line
 275   end
 276
 277   file "create:#{rails_directory}/config/application.yml" do
 278     path "#{rails_directory}/config/application.yml"
 279     owner new_resource.user
 280     group new_resource.group
 281     mode "664"
 282     content application_yml
 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     "oauth_application",
 303     "nominatim_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   ).compact.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   end
 387
 388   execute "#{rails_directory}/db/migrate" do
 389     action :nothing
 390     command "bundle#{new_resource.ruby} exec rake db:migrate"
 391     cwd rails_directory
 392     user new_resource.user
 393     group new_resource.group
 394     subscribes :run, "git[#{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     only_if { new_resource.build_assets }
 442   end
 443
 444   file "#{rails_directory}/public/export/embed.html" do
 445     action :nothing
 446     subscribes :delete, "git[#{rails_directory}]"
 447     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 448   end
 449
 450   passenger_application rails_directory do
 451     action :nothing
 452     subscribes :restart, "git[#{rails_directory}]"
 453     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 454     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 455     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 456     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 457     subscribes :restart, "file[#{rails_directory}/config/piwik.yml]"
 458     subscribes :restart, "execute[#{rails_directory}/Gemfile]"
 459     subscribes :restart, "execute[#{rails_directory}/db/migrate]"
 460     subscribes :restart, "execute[#{rails_directory}/package.json]"
 461     subscribes :restart, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 462     subscribes :restart, "execute[#{rails_directory}/public/assets]"
 463     only_if { ::File.exist?("/usr/bin/passenger-config") }
 464   end
 465
 466   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 467     cookbook "web"
 468     source "rails.cron.erb"
 469     owner "root"
 470     group "root"
 471     mode "755"
 472     variables :directory => rails_directory
 473   end
 474 end
 475
 476 action :restart do
 477   passenger_application rails_directory do
 478     action :restart
 479   end
 480 end
 481
 482 action_class do
 483   include Chef::Mixin::EditFile
 484
 485   def rails_directory
 486     new_resource.directory || "/srv/#{new_resource.site}"
 487   end
 488 end