Merge 751fab0 into 10c04be

PyRIGS/settings.py

@@ -21,10 +21,15 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = bool(int(os.environ.get('DEBUG'))) if os.environ.get('DEBUG') else True
 
+STAGING = bool(int(os.environ.get('STAGING'))) if os.environ.get('STAGING') else False
+
 TEMPLATE_DEBUG = True
 
 ALLOWED_HOSTS = ['pyrigs.nottinghamtec.co.uk', 'rigs.nottinghamtec.co.uk', 'pyrigs.herokuapp.com']
 
+if STAGING:
+    ALLOWED_HOSTS.append('.herokuapp.com')
+
 SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
 if not DEBUG:
     SECURE_SSL_REDIRECT = True # Redirect all http requests to https

README.md

@@ -75,5 +75,22 @@ python manage.py runserver
 ```
 Please refer to Django documentation for a full list of options available here.
 
+### Sample Data ###
+Sample data is available to aid local development and user acceptance testing. To load this data into your local database, first ensure the database is empty:
+```
+python manage.py flush
+```
+Then load the sample data using the command:
+```
+python manage.py generateSampleData
+```
+4 user accounts are created for convenience:
+|Username |Password |
+|---------|---------|
+|superuser|superuser|
+|finance  |finance  |
+|keyholder|keyholder|
+|basic    |basic    |
+
 ### Committing, pushing and testing ###
 Feel free to commit as you wish, on your own branch. On my branch (master for development) do not commit code that you either know doesn't work or don't know works. If you must commit this code, please make sure you say in the commit message that it isn't working, and if you can why it isn't working. If and only if you absolutely must push, then please don't leave it as the HEAD for too long, it's not much to ask but when you are done just make sure you haven't broken the HEAD for the next person.

RIGS/management/commands/generateSampleData.py

@@ -0,0 +1,242 @@
+from django.core.management.base import BaseCommand, CommandError
+from django.contrib.auth.models import Group, Permission
+from django.db import transaction
+import reversion
+
+import datetime
+import random
+
+from RIGS import models
+class Command(BaseCommand):
+    help = 'Adds sample data to use for testing'
+    can_import_settings = True
+
+    people = []
+    organisations = []
+    venues = []
+    profiles = []
+
+    keyholder_group = None
+    finance_group = None
+
+
+    def handle(self, *args, **options):
+        from django.conf import settings
+
+        if not (settings.DEBUG or settings.STAGING):
+            raise CommandError('You cannot run this command in production')
+
+        random.seed('Some object to seed the random number generator') # otherwise it is done by time, which could lead to inconsistant tests
+
+        with transaction.atomic():
+            models.VatRate.objects.create(start_at='2014-03-05',rate=0.20,comment='test1')
+
+            self.setupGenericProfiles()
+
+            self.setupPeople()
+            self.setupOrganisations()
+            self.setupVenues()
+
+            self.setupGroups()
+
+            self.setupEvents()
+
+            self.setupUsefulProfiles()
+
+    def setupPeople(self):
+        names = ["Regulus Black","Sirius Black","Lavender Brown","Cho Chang","Vincent Crabbe","Vincent Crabbe","Bartemius Crouch","Fleur Delacour","Cedric Diggory","Alberforth Dumbledore","Albus Dumbledore","Dudley Dursley","Petunia Dursley","Vernon Dursley","Argus Filch","Seamus Finnigan","Nicolas Flamel","Cornelius Fudge","Goyle","Gregory Goyle","Hermione Granger","Rubeus Hagrid","Igor Karkaroff","Viktor Krum","Bellatrix Lestrange","Alice Longbottom","Frank Longbottom","Neville Longbottom","Luna Lovegood","Xenophilius Lovegood","Remus Lupin","Draco Malfoy","Lucius Malfoy","Narcissa Malfoy","Olympe Maxime","Minerva McGonagall","Mad-Eye Moody","Peter Pettigrew","Harry Potter","James Potter","Lily Potter","Quirinus Quirrell","Tom Riddle","Mary Riddle","Lord Voldemort","Rita Skeeter","Severus Snape","Nymphadora Tonks","Dolores Janes Umbridge","Arthur Weasley","Bill Weasley","Charlie Weasley","Fred Weasley","George Weasley","Ginny Weasley","Molly Weasley","Percy Weasley","Ron Weasley","Dobby","Fluffy","Hedwig","Moaning Myrtle","Aragog","Grawp"]
+        for i, name in enumerate(names):
+            with reversion.create_revision():
+                reversion.set_user(random.choice(self.profiles))
+
+                newPerson = models.Person.objects.create(name=name)
+                if i % 3 == 0:
+                    newPerson.email = "address@person.com"
+
+                if i % 5 == 0:
+                    newPerson.notes = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
+
+                if i % 7 == 0:
+                    newPerson.address = "1 Person Test Street \n Demoton \n United States of TEC \n RMRF 567"
+
+                if i % 9 == 0:
+                    newPerson.phone = "01234 567894"
+
+                newPerson.save()
+                self.people.append(newPerson)
+
+    def setupOrganisations(self):
+        names = ["Acme, inc.","Widget Corp","123 Warehousing","Demo Company","Smith and Co.","Foo Bars","ABC Telecom","Fake Brothers","QWERTY Logistics","Demo, inc.","Sample Company","Sample, inc","Acme Corp","Allied Biscuit","Ankh-Sto Associates","Extensive Enterprise","Galaxy Corp","Globo-Chem","Mr. Sparkle","Globex Corporation","LexCorp","LuthorCorp","North Central Positronics","Omni Consimer Products","Praxis Corporation","Sombra Corporation","Sto Plains Holdings","Tessier-Ashpool","Wayne Enterprises","Wentworth Industries","ZiffCorp","Bluth Company","Strickland Propane","Thatherton Fuels","Three Waters","Water and Power","Western Gas & Electric","Mammoth Pictures","Mooby Corp","Gringotts","Thrift Bank","Flowers By Irene","The Legitimate Businessmens Club","Osato Chemicals","Transworld Consortium","Universal Export","United Fried Chicken","Virtucon","Kumatsu Motors","Keedsler Motors","Powell Motors","Industrial Automation","Sirius Cybernetics Corporation","U.S. Robotics and Mechanical Men","Colonial Movers","Corellian Engineering Corporation","Incom Corporation","General Products","Leeding Engines Ltd.","Blammo","Input, Inc.","Mainway Toys","Videlectrix","Zevo Toys","Ajax","Axis Chemical Co.","Barrytron","Carrys Candles","Cogswell Cogs","Spacely Sprockets","General Forge and Foundry","Duff Brewing Company","Dunder Mifflin","General Services Corporation","Monarch Playing Card Co.","Krustyco","Initech","Roboto Industries","Primatech","Sonky Rubber Goods","St. Anky Beer","Stay Puft Corporation","Vandelay Industries","Wernham Hogg","Gadgetron","Burleigh and Stronginthearm","BLAND Corporation","Nordyne Defense Dynamics","Petrox Oil Company","Roxxon","McMahon and Tate","Sixty Second Avenue","Charles Townsend Agency","Spade and Archer","Megadodo Publications","Rouster and Sideways","C.H. Lavatory and Sons","Globo Gym American Corp","The New Firm","SpringShield","Compuglobalhypermeganet","Data Systems","Gizmonic Institute","Initrode","Taggart Transcontinental","Atlantic Northern","Niagular","Plow King","Big Kahuna Burger","Big T Burgers and Fries","Chez Quis","Chotchkies","The Frying Dutchman","Klimpys","The Krusty Krab","Monks Diner","Milliways","Minuteman Cafe","Taco Grande","Tip Top Cafe","Moes Tavern","Central Perk","Chasers"]
+        for i, name in enumerate(names):
+            with reversion.create_revision():
+                reversion.set_user(random.choice(self.profiles))
+                newOrganisation = models.Organisation.objects.create(name=name)
+                if i % 2 == 0:
+                    newOrganisation.has_su_account = True
+
+                if i % 3 == 0:
+                    newOrganisation.email = "address@organisation.com"
+
+                if i % 5 == 0:
+                    newOrganisation.notes = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
+
+                if i % 7 == 0:
+                    newOrganisation.address = "1 Organisation Test Street \n Demoton \n United States of TEC \n RMRF 567"
+
+                if i % 9 == 0:
+                    newOrganisation.phone = "01234 567894"
+
+                newOrganisation.save()
+                self.organisations.append(newOrganisation)
+
+    def setupVenues(self):
+        names = ["Bear Island","Crossroads Inn","Deepwood Motte","The Dreadfort","The Eyrie","Greywater Watch","The Iron Islands","Karhold","Moat Cailin","Oldstones","Raventree Hall","Riverlands","The Ruby Ford","Saltpans","Seagard","Torrhen's Square","The Trident","The Twins","The Vale of Arryn","The Whispering Wood","White Harbor","Winterfell","The Arbor","Ashemark","Brightwater Keep","Casterly Rock","Clegane's Keep","Dragonstone","Dorne","God's Eye","The Golden Tooth","Harrenhal","Highgarden","Horn Hill","Fingers","King's Landing","Lannisport","Oldtown","Rainswood","Storm's End","Summerhall","Sunspear","Tarth","Castle Black","Craster's Keep","Fist of the First Men","The Frostfangs","The Gift","The Skirling Pass","The Wall","Asshai","Astapor","Braavos","The Dothraki Sea","Lys","Meereen","Myr","Norvos","Pentos","Qarth","Qohor","The Red Waste","Tyrosh","Vaes Dothrak","Valyria","Village of the Lhazareen","Volantis","Yunkai"]
+        for i, name in enumerate(names):
+            with reversion.create_revision():
+                reversion.set_user(random.choice(self.profiles))
+                newVenue = models.Venue.objects.create(name=name)
+                if i % 2 == 0:
+                    newVenue.three_phase_available = True
+
+                if i % 3 == 0:
+                    newVenue.email = "address@venue.com"
+
+                if i % 5 == 0:
+                    newVenue.notes = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
+
+                if i % 7 == 0:
+                    newVenue.address = "1 Venue Test Street \n Demoton \n United States of TEC \n RMRF 567"
+
+                if i % 9 == 0:
+                    newVenue.phone = "01234 567894"
+
+                newVenue.save()
+                self.venues.append(newVenue)
+
+    def setupGroups(self):
+        self.keyholder_group = Group.objects.create(name='Keyholders')
+        self.finance_group = Group.objects.create(name='Finance')
+
+        keyholderPerms = ["add_event","change_event","view_event","add_eventitem","change_eventitem","delete_eventitem","add_organisation","change_organisation","view_organisation","add_person","change_person","view_person","view_profile","add_venue","change_venue","view_venue"]
+        financePerms = ["change_event","view_event","add_eventitem","change_eventitem","add_invoice","change_invoice","view_invoice","add_organisation","change_organisation","view_organisation","add_payment","change_payment","delete_payment","add_person","change_person","view_person"]
+
+        for permId in keyholderPerms:
+            self.keyholder_group.permissions.add(Permission.objects.get(codename=permId))
+
+        for permId in financePerms:
+            self.finance_group.permissions.add(Permission.objects.get(codename=permId))
+
+    def setupGenericProfiles(self):
+        names = ["Clara Oswin Oswald","Rory Williams","Amy Pond","River Song","Martha Jones","Donna Noble","Jack Harkness","Mickey Smith","Rose Tyler"]
+        for i, name in enumerate(names):
+            newProfile = models.Profile.objects.create(username=name.replace(" ",""), first_name=name.split(" ")[0], last_name=name.split(" ")[-1],
+                                                         email=name.replace(" ","")+"@example.com",
+                                                        initials="".join([ j[0].upper() for j in name.split() ]))
+            if i % 2 == 0:
+                newProfile.phone = "01234 567894"
+
+            newProfile.save()
+            self.profiles.append(newProfile)
+
+    def setupUsefulProfiles(self):
+        superUser = models.Profile.objects.create(username="superuser", first_name="Super", last_name="User", initials="SU", 
+                                                email="superuser@example.com", is_superuser=True, is_active=True, is_staff=True)
+        superUser.set_password('superuser')
+        superUser.save()
+
+        financeUser = models.Profile.objects.create(username="finance", first_name="Finance", last_name="User", initials="FU", 
+                                                email="financeuser@example.com", is_active=True)
+        financeUser.groups.add(self.finance_group)
+        financeUser.set_password('finance')
+        financeUser.save()
+
+        keyholderUser = models.Profile.objects.create(username="keyholder", first_name="Keyholder", last_name="User", initials="KU", 
+                                                email="keyholderuser@example.com", is_active=True)
+        keyholderUser.groups.add(self.keyholder_group)
+        keyholderUser.set_password('keyholder')
+        keyholderUser.save()
+
+        basicUser = models.Profile.objects.create(username="basic", first_name="Basic", last_name="User", initials="BU", 
+                                                email="basicuser@example.com", is_active=True)
+        basicUser.set_password('basic')
+        basicUser.save()
+
+    def setupEvents(self):
+        names = ["Outdoor Concert","Hall Open Mic Night","Festival","Weekend Event","Magic Show","Society Ball","Evening Show","Talent Show","Acoustic Evening","Hire of Things","SU Event","End of Term Show","Theatre Show","Outdoor Fun Day","Summer Carnival","Open Days","Magic Show","Awards Ceremony","Debating Event","Club Night","DJ Evening","Building Projection","Choir Concert"]
+        descriptions = ["A brief desciption of the event","This event is boring","Probably wont happen","Warning: this has lots of kit"]
+        notes = ["The client came into the office at some point","Who knows if this will happen", "Probably should check this event", "Maybe not happening", "Run away!"]
+
+        itemOptions = [{'name': 'Speakers', 'description': 'Some really really big speakers \n these are very loud', 'quantity': 2, 'cost': 200.00},
+                        {'name': 'Projector', 'description': 'Some kind of video thinamejig, probably with unnecessary processing for free', 'quantity': 1, 'cost': 500.00},
+                        {'name': 'Lighting Desk', 'description': 'Cannot provide guarentee that it will work', 'quantity': 1, 'cost': 200.52},
+                        {'name': 'Moving lights', 'description': 'Flashy lights, with the copper', 'quantity': 8, 'cost': 50.00},
+                        {'name': 'Microphones', 'description': 'Make loud noise \n you will want speakers with this', 'quantity': 5, 'cost': 0.50},
+                        {'name': 'Sound Mixer Thing', 'description': 'Might be analogue, might be digital', 'quantity': 1, 'cost': 100.00},
+                        {'name': 'Electricity', 'description': 'You need this', 'quantity': 1, 'cost': 200.00},
+                        {'name': 'Crew', 'description': 'Costs nothing, because reasons', 'quantity': 1, 'cost': 0.00},
+                        {'name': 'Loyalty Discount', 'description': 'Have some negative moneys', 'quantity': 1, 'cost': -50.00}]
+
+        dayDelta = -120 # start adding events from 4 months ago
+
+        for i in range(150): # Let's add 100 events
+            with reversion.create_revision():
+                reversion.set_user(random.choice(self.profiles))
+
+                name = names[i%len(names)]
+
+                startDate = datetime.date.today() + datetime.timedelta(days=dayDelta)
+                dayDelta = dayDelta + random.randint(0,3)
+
+                newEvent = models.Event.objects.create(name=name, start_date=startDate)
+
+                if random.randint(0,2) > 1: # 1 in 3 have a start time
+                    newEvent.start_time = datetime.time(random.randint(15,20))
+                    if random.randint(0,2) > 1: # of those, 1 in 3 have an end time on the same day
+                        newEvent.end_time = datetime.time(random.randint(21,23))
+                    elif random.randint(0,1)>0: # half of the others finish early the next day
+                        newEvent.end_date = newEvent.start_date + datetime.timedelta(days=1)
+                        newEvent.end_time = datetime.time(random.randint(0,5))
+                elif random.randint(0,2)>1: # 1 in 3 of the others finish a few days ahead
+                    newEvent.end_date = newEvent.start_date + datetime.timedelta(days=random.randint(1,4))
+
+
+                if random.randint(0,6) > 0: # 5 in 6 have MIC
+                    newEvent.mic = random.choice(self.profiles)
+
+                if random.randint(0,6) > 0: # 5 in 6 have organisation
+                    newEvent.organisation = random.choice(self.organisations)
+
+                if random.randint(0,6) > 0: # 5 in 6 have person
+                    newEvent.person = random.choice(self.people)
+
+                if random.randint(0,6) > 0: # 5 in 6 have venue
+                    newEvent.venue = random.choice(self.venues)
+
+                # Could have any status, equally weighted
+                newEvent.status = random.choice([models.Event.BOOKED,models.Event.CONFIRMED,models.Event.PROVISIONAL, models.Event.CANCELLED])
+
+                newEvent.dry_hire = (random.randint(0,7)==0) # 1 in 7 are dry hire
+
+                if random.randint(0,1) > 0: # 1 in 2 have description
+                    newEvent.description = random.choice(descriptions)
+
+                if random.randint(0,1) > 0: # 1 in 2 have notes
+                    newEvent.notes = random.choice(notes)
+
+                newEvent.save()
+
+                # Now add some items
+                for j in range(random.randint(1,5)):
+                    itemData = itemOptions[random.randint(0,len(itemOptions)-1)]
+                    newItem = models.EventItem.objects.create(event=newEvent, order=j, **itemData)
+                    newItem.save()
+
+            with reversion.create_revision():
+                reversion.set_user(random.choice(self.profiles))
+                if newEvent.start_date < datetime.date.today(): # think about adding an invoice
+                    if random.randint(0,2) > 0: # 2 in 3 have had paperwork sent to treasury
+                        newInvoice = models.Invoice.objects.create(event=newEvent)
+                        if newEvent.status is models.Event.CANCELLED: # void cancelled events
+                            newInvoice.void = True
+                        elif random.randint(0,2)>1: # 1 in 3 have been paid
+                            models.Payment.objects.create(invoice=newInvoice, amount=newInvoice.balance, date=datetime.date.today())

RIGS/test_unit.py

@@ -5,6 +5,8 @@
 from RIGS import models
 from django.core.exceptions import ObjectDoesNotExist
 
+from django.core.management import call_command
+from django.test.utils import override_settings
 
 class TestAdminMergeObjects(TestCase):
     @classmethod
@@ -208,4 +210,15 @@ def test_invoice_delete_not_allowed(self):
         response = self.client.post(request_url, follow=True)
 
         # Check this didn't work
-        self.assertTrue(models.Invoice.objects.get(pk=self.invoices[1].pk))
+        self.assertTrue(models.Invoice.objects.get(pk=self.invoices[1].pk))
+
+class TestSampleDataGenerator(TestCase):
+    @override_settings(DEBUG=True)
+    def test_generate_sample_data(self):
+
+        # Run the management command and check there are no exceptions
+        call_command('generateSampleData')
+
+        # Check there are lots of events
+        self.assertTrue(models.Event.objects.all().count() > 100)
+

app.json

@@ -2,12 +2,13 @@
   "name": "PyRIGS",
   "description": "",
   "scripts": {
-    "postdeploy": "python manage.py migrate"
+    "postdeploy": "python manage.py migrate && python manage.py generateSampleData"
   },
   "env": {
     "DEBUG": {
       "required": true
     },
+    "STAGING": "1",
     "EMAIL_FROM": {
       "required": true
     },