Supermarket

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

Umbrella Project: Supermarket

• Project State: Maintained
• Issues Response Time Maximum: 14 days
• Pull Request Response Time Maximum: 14 days

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 ZenHub.

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 and the omnibus definition used to build the deb/rpm packages. Other Supermarket related repositories are:

• chef-cookbooks/supermarket-omnibus-cookbook: This cookbook is used to deploy Supermarket through the Supermarket omnibus package. For details on using this cookbook to install Supermarket omnibus, check out this webinar by the Supermarket Engineering team.

Requirements

• Ruby 2.6.8
• PostgreSQL 9.3
• Redis 3.0

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 macOS Catalina (10.15)

Dependency Services

As Docker Containers

1. Install docker

   brew cask install docker

   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 the service is started.

2. Start the docker containers

   cd src/supermarket
   docker-compose up

As Locally Running Processes

1. Install Postgres - There are a few ways to get PostgreSQL running on macOS

   • 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:

     brew install postgresql

     NOTE: 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

2. Install Redis. You can install this with Homebrew. Follow the instructions in the install output to start the redis server.

   brew install redis

   Run the redis server using command:

   redis-server --daemonize yes
   

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 the appropriate Ruby release such as:

   • RVM
   • Rbenv
   • chruby
   • or any other Ruby version manager that may come along

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

4. Make sure you have the Supermarket repo cloned to your machine, then change into that directory

   $ cd <supermarket-repo>
   

5. Then change into the src

   $ cd src/supermarket
   

6. Install Bundler gem

   gem install bundler:2.1.4 --user-install
   

7. Install required gems:

   bundle install
   

   N.B. you might get the following errors. Listing them with the fixes.

   • Error installing gem: ruby-filemagic
     • Fix -> brew install libmagic
   • Error installing gem: mimemagic
     • Fix-> brew install shared-mime-info

8. Create the database, migrate the database and seed the database:

   $ bundle exec rails db:setup
   

9. Add required Postgres extensions.

   $ psql supermarket_development -c 'create extension plpgsql'
   $ psql supermarket_development -c 'create extension pg_trgm'
   

   N.B. Ignore if the above 2 commands gives error: extenstion already exists.

10. Start the server:

    $ bundle exec foreman start
    

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

Setting up Auth

Supermarket uses oc-id running on a Chef Infra 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 Infra Server running oc-id. We are working on a solution that 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

There are a couple features that depend on GitHub integration (CLA signing, some quality metrics in Fieri). You can set up an integration for your development environment by creating an application with your Github account. To do this:

1. Log into your Github account 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]

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 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.

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:

• tools
• fieri
• announcement
• github
• no_crawl

Deprecated Features

CLA signing still works, but has been disabled in the public site in favor of the DCO process which tracked outside of Supermarket.

• cla
• join_ccla

License

Copyright:	Copyright (c) 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.