Merge pull request #450 from digitalocean/kjuell/docker-dev

Add local Docker setup

Author: katjuell

.dockerignore

@@ -0,0 +1,10 @@
+.git*
+tmp/*
+.dockerignore
+Dockerfile
+docker-compose.yml
+README.md
+coverage/*
+ci/*
+docc/*
+log/*

.github/workflows/test.yml

@@ -30,6 +30,8 @@ jobs:
       AIRTABLE_APP_ID: ${{ secrets.AIRTABLE_APP_ID }}
       AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
       SEGMENT_WRITE_KEY: ${{ secrets.SEGMENT_WRITE_KEY }}
+      REDIS_HOST: localhost
+      REDIS_PORT: 6379
 
     steps:
     - uses: actions/checkout@v1

Dockerfile-nginx

@@ -0,0 +1,11 @@
+### Config for nginx instance that serves community
+FROM nginx:1.13.12-alpine
+MAINTAINER web-experience@digitalocean.com
+
+WORKDIR /home/deploy/hacktoberfest/current/public
+
+# Copy the configuration over
+COPY config/nginx/nginx.conf /etc/nginx/conf.d/default.conf
+
+# Create health check
+RUN echo "OK" > health_check.txt

Dockerfile.dev

@@ -0,0 +1,38 @@
+FROM ruby:2.5-slim AS base
+
+ENV BUNDLER_VERSION=2.0.2
+ENV REDIS_HOST=redis
+
+RUN apt-get update && apt-get install -y apt-transport-https bash curl git gnupg2 build-essential libpq-dev \
+&& curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - \
+&& echo 'deb https://deb.nodesource.com/node_12.x jessie main' > /etc/apt/sources.list.d/nodesource.list
+
+RUN apt-get update \
+  && apt-get install -y \
+    nodejs \ 
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY . ./
+
+RUN gem install bundler -v 2.1.4
+
+COPY Gemfile Gemfile.lock ./
+
+RUN bundle check || bundle install --without production
+
+###############################
+FROM ruby:2.5
+
+COPY --from=base /usr/bin/node /usr/bin/node
+COPY --from=base /usr/local/bundle /usr/local/bundle
+
+WORKDIR /app
+
+COPY --from=base /app /app
+
+ENTRYPOINT ["./script/docker-entrypoint.sh"]
+
+EXPOSE 3000

Gemfile

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-ruby File.read(File.expand_path("../.ruby-version", __FILE__)).chomp
+git_source(:github) { |repo| "https://github.com/digitalocean/hacktoberfest.git" }
 
 gem 'airbrake', '~> 9.4'
 gem 'airrecord'
@@ -39,18 +38,21 @@ gem 'rails', '~> 5.2.3'
 
 gem 'sass-rails', '~> 5.0'
 gem 'sidekiq', '< 6.0'
+gem 'sidekiq-scheduler'
+
+# commenting out these settings since we are not using enterprise sidekiq in local docker dev
+#unless ENV['RAILS_ENV'] == 'production' || ENV['RAILS_ENV'] == 'staging' || ENV['REDIS_HOST'] == 'redis'
+#  require 'dotenv'
+#  Dotenv.load['BUNDLE_ENTERPRISE__CONTRIBSYS__COM']
+#end
+
+#install_if -> { ENV['BUNDLE_ENTERPRISE__CONTRIBSYS__COM'] } do
+#  source 'https://enterprise.contribsys.com/' do
+#    gem 'sidekiq-pro'
+#    gem 'sidekiq-ent'
+#  end
+#end
 
-# unless ENV['RAILS_ENV'] == 'production' || ENV['RAILS_ENV'] == 'staging'
-#   require 'dotenv'
-#   Dotenv.load['BUNDLE_ENTERPRISE__CONTRIBSYS__COM']
-# end
-#
-# install_if -> { ENV['BUNDLE_ENTERPRISE__CONTRIBSYS__COM'] } do
-#   source 'https://enterprise.contribsys.com/' do
-#     gem 'sidekiq-pro'
-#     gem 'sidekiq-ent'
-#   end
-# end
 
 gem 'state_machines'
 gem 'state_machines-activerecord'

Gemfile.lock

@@ -100,7 +100,10 @@ GEM
     dotenv-rails (2.7.5)
       dotenv (= 2.7.5)
       railties (>= 3.2, < 6.1)
+    e2mmap (0.1.0)
     erubi (1.8.0)
+    et-orbi (1.2.4)
+      tzinfo
     execjs (2.7.0)
     factory_bot (5.0.2)
       activesupport (>= 4.2.0)
@@ -113,6 +116,9 @@ GEM
       faraday (>= 0.7.4, < 1.0)
     ffi (1.11.1)
     formatador (0.2.5)
+    fugit (1.3.7)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.3)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     guard (2.15.1)
@@ -202,6 +208,7 @@ GEM
     public_suffix (4.0.1)
     puma (4.1.1)
       nio4r (~> 2.0)
+    raabro (1.3.1)
     rack (2.0.7)
     rack-protection (2.0.7)
       rack
@@ -271,6 +278,8 @@ GEM
       rubocop (>= 0.72.0)
     ruby-progressbar (1.10.1)
     ruby_dep (1.5.0)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
     safe_yaml (1.0.5)
     sass (3.4.25)
     sass-rails (5.1.0)
@@ -292,6 +301,13 @@ GEM
       rack (>= 1.5.0)
       rack-protection (>= 1.5.0)
       redis (>= 3.3.5, < 5)
+    sidekiq-scheduler (3.0.1)
+      e2mmap
+      redis (>= 3, < 5)
+      rufus-scheduler (~> 3.2)
+      sidekiq (>= 3)
+      thwait
+      tilt (>= 1.4.0)
     spring (2.1.0)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
@@ -316,6 +332,8 @@ GEM
     terminal-notifier-guard (1.7.0)
     thor (0.20.3)
     thread_safe (0.3.6)
+    thwait (0.2.0)
+      e2mmap
     tilt (2.0.9)
     turbolinks (5.2.0)
       turbolinks-source (~> 5.2)
@@ -379,6 +397,7 @@ DEPENDENCIES
   sass-rails (~> 5.0)
   shoulda-matchers
   sidekiq (< 6.0)
+  sidekiq-scheduler
   spring
   spring-watcher-listen (~> 2.0.0)
   state_machines
@@ -391,8 +410,5 @@ DEPENDENCIES
   web-console (>= 3.3.0)
   webmock
 
-RUBY VERSION
-   ruby 2.5.8p224
-
 BUNDLED WITH
    2.1.4

README.md

@@ -39,10 +39,11 @@ These instructions will get you a copy of the project up and running on your loc
 ## Application Setup
 
 1) [Install and Setup](#installing)
-2) [Setup Oauth Token](#setup-oauth-token)
-3) [Configure remaining environment variales](#env-variables)
-4) [Create first user](#create-first-user)
-5) [Import Projects](#import-projects)
+2) [Local Setup With Docker](#local-setup-with-docker)
+3) [Setup Oauth Token](#setup-oauth-token)
+4) [Configure remaining environment variales](#env-variables)
+5) [Create first user](#create-first-user)
+6) [Import Projects](#import-projects)
 
 ### Installing
 
@@ -57,6 +58,44 @@ In your local repository, run script/setup, which will install all necessary dep
 ```
 script/setup
 ```
+### Local Setup With Docker
+
+If you would like to use Docker to work with the application, first make sure that you have Docker and Docker Compose on your local machine.
+
+Next clone the repo as described in [Step 1](#installing). 
+
+From there, create a local `.env` file, and add fill out the following values, using steps [3](#setup-oauth-token) and [4](#env-variables) to guide you:
+
+```
+HACKTOBERFEST_DATABASE_HOST=database
+HACKTOBERFEST_DATABASE_USERNAME=
+HACKTOBERFEST_DATABASE_PASSWORD=
+REDIS_HOST=redis
+REDIS_PORT=6379
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+START_DATE=
+END_DATE=
+AIRTABLE_API_KEY=
+AIRTABLE_APP_ID=
+```
+**Note**: Use the following values when setting up your Oauth token:
+
+```
+> Homepage URL: `http://localhost`\
+> Authorization callback URL: `http://localhost/auth/github/callback`
+```
+The local Docker setup uses a webserver, in the same way that the application does in staging and production, so it will be reachable on port `80`.
+
+Run `docker-compose up -d` to start your services. 
+
+**Testing**
+
+If you would like to run commands against your app service, you can do that with the following command (using rubocop as an example): 
+
+```
+docker-compose run app --entrypoint "bundle exec rubocop app config db lib spec --safe-auto-correct"
+```
 
 ### Setup Oauth Token
 

app/models/github_pull_request.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class GithubPullRequest
+  attr_accessor :graphql_hash
+
   def initialize(hash)
     @graphql_hash = hash
   end

config/initializers/sidekiq.rb

@@ -10,7 +10,10 @@
     url: redis_url,
     password: ENV.fetch('HACKTOBERFEST_REDIS_PASSWORD', nil)
   }
+elsif (redis_url = ENV.fetch('REDIS_HOST', nil))
+  REDIS_LOCAL = { url:  "redis://#{redis_url}:#{ENV['REDIS_PORT']}/12" }
 end
+
 # rubocop:enable Style/MutableConstant
 
 # Custom Error message reporting a job death to airbrake
@@ -28,46 +31,11 @@ def message
 end
 
 Sidekiq.configure_server do |config|
-  config.redis = REDIS_CONFIG if defined?(REDIS_CONFIG)
-
-  # https://github.com/mperham/sidekiq/wiki/Reliability#using-super_fetch
-  config.super_fetch!
-
-  # Periodic job setup
-  # See: https://github.com/mperham/sidekiq/wiki/Ent-Periodic-Jobs
-  config.periodic do |mgr|
-    # Every hour
-    mgr.register(
-      '0 */2 * * *',
-      TransitionAllUsersJob,
-      retry: 3,
-      queue: :critical
-    )
-    # Every day at 3AM
-    mgr.register('0 3 * * *', UpdateAllIssuesJob, retry: 3, queue: :critical)
-    # Every day at 5AM
-    mgr.register(
-      '0 5 * * *',
-      UpdateAllIssuesQualityJob,
-      retry: 3,
-      queue: :default
-    )
-    # Every hour. 1 hour max latency when updating banned repos in airtable
-    mgr.register(
-      '0 * * * *',
-      BanAllReposJob,
-      retry: 3,
-      queue: :default
-    )
-
-    # Every 15 minutes
-    mgr.register(
-      '*/15 * * * *',
-      FetchSpamRepositoriesJob,
-      retry: 3,
-      queue: :default
-    )
-  end
+  config.redis = if defined?(REDIS_CONFIG)
+                   REDIS_CONFIG
+                 elsif defined?(REDIS_LOCAL)
+                   REDIS_LOCAL
+                 end
 
   config.death_handlers << lambda { |job, ex|
     error = Sidekiq::JobDeathError.new(job, ex)
@@ -78,5 +46,9 @@ def message
 end
 
 Sidekiq.configure_client do |config|
-  config.redis = REDIS_CONFIG if defined?(REDIS_CONFIG)
+  config.redis = if defined?(REDIS_CONFIG)
+                   REDIS_CONFIG
+                 elsif defined?(REDIS_LOCAL)
+                   REDIS_LOCAL
+                 end
 end