Skip to content

Latest commit

 

History

History
323 lines (231 loc) · 12.5 KB

README.md

File metadata and controls

323 lines (231 loc) · 12.5 KB
Raw

Supermarket

Build Status Dependency Status Code Climate Inline docs

Supermarket is Chef's community repository for cookbooks, currently hosted at supermarket.chef.io. Supermarket can also be run internally, behind-the-firewall.

The code is designed to be easy for others to contribute to. To that end, the goal of this README is to introduce you to the project and get you up and running. More information about Supermarket can be found in the wiki. You can follow along with the project development in waffle.io.

If you want to contribute to Supermarket, read the contributor's workflow for license information and helpful tips to get you started. There are project artifacts such as planning docs, wireframes, recorded demos, and team retrospectives in a public Google Drive folder.

If you have questions, feature ideas, or other suggestions, please open a GitHub Issue.

This repository has the code for the Supermarket application, related repositories are:

Requirements

  • Ruby 2.1.8
  • PostgreSQL 9.3
  • Redis 2.4+

Development

Configuring

Configure the dotenv keys and secrets to . See .env.example for required keys and secrets to get up and running. docs/CONFIGURING.md goes into detail about the not-so-straightforward configuration that needs to happen to get Supermarket working locally.

Local Environment

These instructions are tested and verified on Mac OS X Yosemite

Dependency Services

As Docker Containers

  1. Install the hypervisor of your choice (e.g. VirtualBox, VMWare Fusion).

  2. Install docker-machine and docker. With Homebrew:

$ brew install docker-machine docker
  1. Create a docker-machine host on which to run Docker services. The following command assumes your hypervisor is VirtualBox and that you will name this host "default".
$ docker-machine create --drive virtualbox default
  1. Set environment variables for the Supermarket configuration:
eval $(docker-machine env default)
export DOCKER_IP=$(docker-machine ip default)
export POSTGRES_IP=$DOCKER_IP
export REDIS_URL="redis://${DOCKER_IP}:6379/0/supermarket"

NOTE: You will still need a version of PostgreSQL installed on the local filesystem for development libraries to be available for building the pg gem. See the instructions for locally running PostgreSQL below, but omit the steps where a service is started.

As Locally Running Processes
  1. Install Postgres - There are a few ways to get PostgreSQL running on OS X
  • Install the Postgres App. This is probably the simplest way to get Postgres running on your mac, it "just works." You can then start a Postgres server through the GUI of the app. If you go this route then you'll have to add "/Applications/Postgres.app/Contents/Versions/9.4/bin/" or the equivalent to your PATH in order to get the pg gem to build.
  • Through Homebrew. When installed through homebrew, Postgres often requires additional configuration, see this blog post for instructions. You can then start the Postgresql server with
$ pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start
  1. Install Redis. You can install this with Homebrew. Follow the instructions in the install output to start the redis server.
$ brew install redis

Development Environment

  1. Make sure you have XCode installed

  2. Install a Ruby manager - if you don't already have one, you will need a Ruby manager to install Ruby 2.1.3 such as:

  3. Use your ruby manager to install Ruby 2.1.3. For instructions on this, please see the manager's documentation.

  4. Install bundler

$ gem install bundler
  1. Make sure you have the Supermarket repo cloned to your machine, then change into that directory
$ cd supermarket-repo
  1. Then change into the src
$ cd src
  1. Install required gems:
$ bundle
  1. Create the database, migrate the database and seed the database:
$ bundle exec rake db:setup
  1. Add required Postgres extensions.
$ psql supermarket_development -c 'create extension plpgsql'
$ psql supermarket_development -c 'create extension pg_trgm'
  1. Start the server:
$ bundle exec foreman start

If you receive errors, make sure that redis and Postgres are running.

Setting up Auth

Supermarket uses oc-id running on a Chef server to authenticate users to Supermarket.

IF YOU ARE AN INTERNAL CHEF STAFFER - there are some special things we need to do to set you up with oc-id. Consult the internal wiki on setting up your Supermarket dev environment (or ask a friendly team member!).

NOTE: Authentication currently requires a live chef server running oc-id. We are working on a solution which would allow a developer to run the authentication locally, stay tuned.

Create a new application and register it on oc-id (I called my application "Application:Supermarket Development"). Set the callback url to http://localhost:3000/auth/chef_oauth2/callback or whatever localhost domain you use.

In your local copy of the Supermarket repo, copy the .env file to .env.development. Open up .env.development and replace these values:

CHEF_OAUTH2_APP_ID=YOUR_CHEF_OAUTH2_APP_ID
CHEF_OAUTH2_SECRET=YOUR_CHEF_OAUTH2_SECRET

with these values:

CHEF_OAUTH2_APP_ID=[Application ID of the oc-id application you just registered]
CHEF_OAUTH2_SECRET=[Secret of the oc-id application you just registered]

Restart your foreman server.

Now when you click on "Sign In" you should be signed into your supermarket account with your Chef account!

NOTE: If you receive an omniauth csrf detected error, try clearing your browser's cache.

Connecting your Github Account

On the production site, users are required to sign a CLA before they can upload cookbooks.

You can simulate this by creating an application with your Github account. To do this:

  1. Log into your Github acount if you aren't already.
  2. Click on your username in the upper right hand corner. This will bring you to your Profile page.
  3. Click the "Edit Profile" button in the upper right corner of the Profile page.
  4. Click on "Applications" in the vertical menu on the left hand side
  5. At the top of the screen you'll see a section labeled "Developer applications" with a button that says "Register new Application." Click on this button.
  6. Name your application whatever you like (I use "Chef-Supermarket-Testing"), the set the homepage url as http://localhost:3000 (or whatever localhost domain that you use). Also set the Authorization callback URL to http://localhost:3000 (or your localhost domain of choice).
  7. Click the "Register application" button.
  8. Open up the .env.development file in your local copy of the Supermarket repo. Replace these values:
GITHUB_KEY=YOUR_GITHUB_KEY
GITHUB_SECRET=YOUR_GITHUB_SECRET

with these values:

GITHUB_KEY=[Your new application's client ID]
GITHUB_SECRET=[Your new application's client secret]

Next, create a Github Access token. You also do this from the "Applications" section of your Profile page.

  1. Look at the "Personal access tokens section heading." Click on the "Generate new token" button.
  2. When prompted, enter your Github password.
  3. Enter whatever you like for the Token description, I use "testing-supermarket"
  4. Leave the scopes at the defaults
  5. Click the "Generate token" button
  6. Copy the token it generates and put it somewhere safe!
  7. Open up your .env.development file again and replace this value:
GITHUB_ACCESS_TOKEN=YOUR_GITHUB_ACCESS_TOKEN

with this value:

GITHUB_ACCESS_TOKEN=[Token you just generated through Github]
  1. Restart your foreman server.
  2. Now hover over your account icon and username in the upper right hand corner of Supermarket in your browser
  3. Click on "Sign CCLA"
  4. Click on the big green button to connect your github account to your local version of Supermarket - this will connect to the application you just created.
  5. Fill in the form for the CCLA (this is just a local copy that will go to your local database, it won't affect the CCLA you signed for Chef).
  6. Click 'Sign CCLA'
  7. Now your local DB will record that you signed the CCLA.

Tests

Requirements for tests: PhantomJS 1.8, Node

Run the entire test suite (rspec, rubocop and mocha) with:

$ bundle exec rake spec:all

Acceptance Tests

Acceptance tests are run with Capybara. Run rake spec:features to run the specs in spec/features. The default rake spec also runs these.

When writing feature specs, the Rack::Test driver is used by default. If the Poltergeist driver is required to be used (for example, an acceptance test that uses AJAX), add the use_poltergeist: true metadata to the spec. See [the remove_members_from_ccla_spec.rb spec] (https://github.com/chef/supermarket/blob/master/spec/features/remove_members_from_ccla_spec.rb#L17) for an example.

Some specs run using PhantomJS, which must be installed for the test suite to pass.

JavaScript Tests

The JavaScript specs are run with Karma and use the Mocha test framework and the Chai Assertion Library

The specs live in spec/javascripts. Run rake spec:javascripts to run the specs, and rake spec:javascripts:watch to run them continuously and watch for changes.

Node.js is required to run the JavaScript tests.

Background Jobs

[Read about Supermarket's background jobs in the wiki] (https://github.com/chef/supermarket/wiki/Background-Jobs).

Feature Flags

Supermarket uses a .env file to configure itself. Inside this file are key/value pairs. These key/value pairs will be exported as environment variables when the app runs, and Supermarket will look for these keys as environment variables when it needs to read a value that's configurable.

One of these keys is called FEATURES and it controls a number of features that can be turned on and off. Here are the available features that can be toggled:

  • cla
  • join_ccla
  • tools
  • fieri
  • announcement
  • github
  • no_crawl

License
Copyright: Copyright (c) 2014-2015 Chef Software, Inc.
License: Apache License, Version 2.0 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.