diff --git a/.gitignore b/.gitignore index 1a64198..41ac920 100644 --- a/.gitignore +++ b/.gitignore @@ -15,4 +15,11 @@ gcp-credentials.json *.rdp -.vagrant \ No newline at end of file +.vagrant + + +__pycache__ + +.env + +*.sqlite3 \ No newline at end of file diff --git a/DevOps-Pipeline-Python/.dockerignore b/DevOps-Pipeline-Python/.dockerignore new file mode 100644 index 0000000..d4442d4 --- /dev/null +++ b/DevOps-Pipeline-Python/.dockerignore @@ -0,0 +1,5 @@ +Dockerfile + +playbook.yml + +README.md \ No newline at end of file diff --git a/DevOps-Pipeline-Python/.env.example b/DevOps-Pipeline-Python/.env.example new file mode 100644 index 0000000..d2819a0 --- /dev/null +++ b/DevOps-Pipeline-Python/.env.example @@ -0,0 +1,19 @@ +SECRET_KEY= + +DEBUG= True + +# DB Connection + +DB_ENGINE=django.db.backends.sqlite3 +DB_NAME=db.sqlite3 +DB_USER= +DB_PASSWORD= +DB_HOST= +DB_PORT= + +# Email Settings + +EMAIL_HOST= +EMAIL_PORT= + +TIME_ZONE=UTC \ No newline at end of file diff --git a/DevOps-Pipeline-Python/Dockerfile b/DevOps-Pipeline-Python/Dockerfile new file mode 100644 index 0000000..61ffd19 --- /dev/null +++ b/DevOps-Pipeline-Python/Dockerfile @@ -0,0 +1,13 @@ +FROM python:alpine + +WORKDIR /usr/src/app + +COPY requirements.txt /usr/src/app + +RUN pip install --no-cache-dir -r requirements.txt + +COPY . /usr/src/app + +CMD [ "python3", "manage.py", "runserver", "0.0.0.0:8000" ] + +EXPOSE 8000 \ No newline at end of file diff --git a/DevOps-Pipeline-Python/README.md b/DevOps-Pipeline-Python/README.md new file mode 100644 index 0000000..bf15443 --- /dev/null +++ b/DevOps-Pipeline-Python/README.md @@ -0,0 +1,38 @@ +# Python-Django-Web-App + +## How to run? + +`NOTE: Make sure you already have Python and Pip installed` + +### Step 1: Create .env file + +` Create .env file from the env.example template and generate new SECRET_KEY using the following website:` + +[DJANGO SECRET KEY GEN](https://djecrety.ir/) + +### Step 2: Create the DataBase + +`Rename the existing database file "db.sqlite3.example" to be "db.sqlite3"` + +### Step 3: Install the requirements.txt + +`Run the follwing command to install the requirements.txt` + +``` +pip install -r requirements.txt + +OR + +pip3 install -r requirements.txt +``` + +### Step 4: Run the application + +`Run the application using the following command` + +`NOTE: Replace with the port number you would like to use ex:8000` + +``` +python3 manage.py runserver 0.0.0.0: + +``` diff --git a/DevOps-Pipeline-Python/db.sqlite3.example b/DevOps-Pipeline-Python/db.sqlite3.example new file mode 100644 index 0000000..b43f2fc Binary files /dev/null and b/DevOps-Pipeline-Python/db.sqlite3.example differ diff --git a/DevOps-Pipeline-Python/environ b/DevOps-Pipeline-Python/environ new file mode 100644 index 0000000..e69de29 diff --git a/DevOps-Pipeline-Python/manage.py b/DevOps-Pipeline-Python/manage.py new file mode 100644 index 0000000..05cba30 --- /dev/null +++ b/DevOps-Pipeline-Python/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'polling.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/DevOps-Pipeline-Python/playbook.yml b/DevOps-Pipeline-Python/playbook.yml new file mode 100644 index 0000000..339f28b --- /dev/null +++ b/DevOps-Pipeline-Python/playbook.yml @@ -0,0 +1,21 @@ +--- +- name: "Automate Docker Build using Ansible" + hosts: localhost + tasks: + - name: stop running container + command: docker stop survey-cont + ignore_errors: yes + + - name: remove stopped container + command: docker rm survey-cont + ignore_errors: yes + + - name: remove used image + command: docker rmi survey-img + ignore_errors: yes + + - name: build docker image from dockerfile + command: docker build -t survey-img . + + - name: run container from image + command: docker run -d --name survey-cont -p 4000:8000 survey-img \ No newline at end of file diff --git a/DevOps-Pipeline-Python/polling/__init__.py b/DevOps-Pipeline-Python/polling/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/DevOps-Pipeline-Python/polling/asgi.py b/DevOps-Pipeline-Python/polling/asgi.py new file mode 100644 index 0000000..07707bd --- /dev/null +++ b/DevOps-Pipeline-Python/polling/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for polling project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'polling.settings') + +application = get_asgi_application() diff --git a/DevOps-Pipeline-Python/polling/settings.py b/DevOps-Pipeline-Python/polling/settings.py new file mode 100644 index 0000000..2e4253c --- /dev/null +++ b/DevOps-Pipeline-Python/polling/settings.py @@ -0,0 +1,128 @@ +""" +Django settings for tester project. + +Generated by 'django-admin startproject' using Django 3.1.1. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.1/ref/settings/ +""" + +from pathlib import Path +import os +from decouple import config +from decouple import Csv + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = config('SECRET_KEY') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = config('DEBUG', default=False, cast=bool) + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'polls', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'polling.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [os.path.join(BASE_DIR, 'templates')], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'polling.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': config('DB_ENGINE'), + 'NAME': config('DB_NAME'), + 'USER': config('DB_USER'), + 'PASSWORD': config('DB_PASSWORD'), + 'HOST': config('DB_HOST'), + 'PORT': config('DB_PORT'), + } +} + + +# Password validation +# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/3.1/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = config('TIME_ZONE') + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.1/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/DevOps-Pipeline-Python/polling/urls.py b/DevOps-Pipeline-Python/polling/urls.py new file mode 100644 index 0000000..e8ad106 --- /dev/null +++ b/DevOps-Pipeline-Python/polling/urls.py @@ -0,0 +1,25 @@ +"""polling URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.1/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import include, path +from django.views.generic import RedirectView +from polls import views + +urlpatterns = [ + path('', RedirectView.as_view(url='polls/', permanent=True)), + path('polls/', include('polls.urls')), + path('admin/', admin.site.urls), +] diff --git a/DevOps-Pipeline-Python/polling/wsgi.py b/DevOps-Pipeline-Python/polling/wsgi.py new file mode 100644 index 0000000..6b5c4ea --- /dev/null +++ b/DevOps-Pipeline-Python/polling/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for polling project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'polling.settings') + +application = get_wsgi_application() diff --git a/DevOps-Pipeline-Python/polls/__init__.py b/DevOps-Pipeline-Python/polls/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/DevOps-Pipeline-Python/polls/admin.py b/DevOps-Pipeline-Python/polls/admin.py new file mode 100644 index 0000000..2cca752 --- /dev/null +++ b/DevOps-Pipeline-Python/polls/admin.py @@ -0,0 +1,9 @@ +from django.contrib import admin +from .models import Question, Choice + +admin.site.site_header = "Polling" +admin.site.site_title = "Polling" +admin.site.index_title = "Welcome to Polling Admin Area" + +admin.site.register(Question) +admin.site.register(Choice) diff --git a/DevOps-Pipeline-Python/polls/apps.py b/DevOps-Pipeline-Python/polls/apps.py new file mode 100644 index 0000000..c46d01b --- /dev/null +++ b/DevOps-Pipeline-Python/polls/apps.py @@ -0,0 +1,5 @@ +from django.apps import AppConfig + + +class PollsConfig(AppConfig): + name = 'polls' diff --git a/DevOps-Pipeline-Python/polls/migrations/0001_initial.py b/DevOps-Pipeline-Python/polls/migrations/0001_initial.py new file mode 100644 index 0000000..cbdce1c --- /dev/null +++ b/DevOps-Pipeline-Python/polls/migrations/0001_initial.py @@ -0,0 +1,32 @@ +# Generated by Django 3.1.1 on 2020-09-02 12:25 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Question', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('question_text', models.CharField(max_length=200)), + ('pub_date', models.DateTimeField(verbose_name='date published')), + ], + ), + migrations.CreateModel( + name='Choice', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('choice_text', models.CharField(max_length=200)), + ('votes', models.IntegerField(default=0)), + ('question', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='polls.question')), + ], + ), + ] diff --git a/DevOps-Pipeline-Python/polls/migrations/__init__.py b/DevOps-Pipeline-Python/polls/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/DevOps-Pipeline-Python/polls/models.py b/DevOps-Pipeline-Python/polls/models.py new file mode 100644 index 0000000..6eed657 --- /dev/null +++ b/DevOps-Pipeline-Python/polls/models.py @@ -0,0 +1,25 @@ +import datetime + +from django.db import models +from django.utils import timezone + + +class Question(models.Model): + question_text = models.CharField(max_length=200) + pub_date = models.DateTimeField('date published') + + def __str__(self): + return self.question_text + + def was_published_recently(self): + now = timezone.now() + return now - datetime.timedelta(days=1) <= self.pub_date <= now + + +class Choice(models.Model): + question = models.ForeignKey(Question, on_delete=models.CASCADE) + choice_text = models.CharField(max_length=200) + votes = models.IntegerField(default=0) + + def __str__(self): + return self.choice_text diff --git a/DevOps-Pipeline-Python/polls/tests.py b/DevOps-Pipeline-Python/polls/tests.py new file mode 100644 index 0000000..a5c9f51 --- /dev/null +++ b/DevOps-Pipeline-Python/polls/tests.py @@ -0,0 +1,125 @@ +import datetime + +from django.test import TestCase +from django.utils import timezone +from django.urls import reverse + +from .models import Question + + +class QuestionModelTests(TestCase): + + def test_was_published_recently_with_future_question(self): + """ + was_published_recently() returns False for questions whose pub_date + is in the future. + """ + time = timezone.now() + datetime.timedelta(days=30) + future_question = Question(pub_date=time) + self.assertIs(future_question.was_published_recently(), False) + + def test_was_published_recently_with_old_question(self): + """ + was_published_recently() returns False for questions whose pub_date + is older than 1 day. + """ + time = timezone.now() - datetime.timedelta(days=1, seconds=1) + old_question = Question(pub_date=time) + self.assertIs(old_question.was_published_recently(), False) + + def test_was_published_recently_with_recent_question(self): + """ + was_published_recently() returns True for questions whose pub_date + is within the last day. + """ + time = timezone.now() - datetime.timedelta(hours=23, minutes=59, seconds=59) + recent_question = Question(pub_date=time) + self.assertIs(recent_question.was_published_recently(), True) + +def create_question(question_text, days): + """ + Create a question with the given `question_text` and published the + given number of `days` offset to now (negative for questions published + in the past, positive for questions that have yet to be published). + """ + time = timezone.now() + datetime.timedelta(days=days) + return Question.objects.create(question_text=question_text, pub_date=time) + + +class QuestionIndexViewTests(TestCase): + def test_no_questions(self): + """ + If no questions exist, an appropriate message is displayed. + """ + response = self.client.get(reverse('polls:index')) + self.assertEqual(response.status_code, 200) + self.assertContains(response, "No polls are available.") + self.assertQuerysetEqual(response.context['latest_question_list'], []) + + def test_past_question(self): + """ + Questions with a pub_date in the past are displayed on the + index page. + """ + create_question(question_text="Past question.", days=-30) + response = self.client.get(reverse('polls:index')) + self.assertQuerysetEqual( + response.context['latest_question_list'], + [''] + ) + + def test_future_question(self): + """ + Questions with a pub_date in the future aren't displayed on + the index page. + """ + create_question(question_text="Future question.", days=30) + response = self.client.get(reverse('polls:index')) + self.assertContains(response, "No polls are available.") + self.assertQuerysetEqual(response.context['latest_question_list'], []) + + def test_future_question_and_past_question(self): + """ + Even if both past and future questions exist, only past questions + are displayed. + """ + create_question(question_text="Past question.", days=-30) + create_question(question_text="Future question.", days=30) + response = self.client.get(reverse('polls:index')) + self.assertQuerysetEqual( + response.context['latest_question_list'], + [''] + ) + + def test_two_past_questions(self): + """ + The questions index page may display multiple questions. + """ + create_question(question_text="Past question 1.", days=-30) + create_question(question_text="Past question 2.", days=-5) + response = self.client.get(reverse('polls:index')) + self.assertQuerysetEqual( + response.context['latest_question_list'], + ['', ''] + ) + +class QuestionDetailViewTests(TestCase): + def test_future_question(self): + """ + The detail view of a question with a pub_date in the future + returns a 404 not found. + """ + future_question = create_question(question_text='Future question.', days=5) + url = reverse('polls:detail', args=(future_question.id,)) + response = self.client.get(url) + self.assertEqual(response.status_code, 404) + + def test_past_question(self): + """ + The detail view of a question with a pub_date in the past + displays the question's text. + """ + past_question = create_question(question_text='Past Question.', days=-5) + url = reverse('polls:detail', args=(past_question.id,)) + response = self.client.get(url) + self.assertContains(response, past_question.question_text) diff --git a/DevOps-Pipeline-Python/polls/urls.py b/DevOps-Pipeline-Python/polls/urls.py new file mode 100644 index 0000000..49d0e6a --- /dev/null +++ b/DevOps-Pipeline-Python/polls/urls.py @@ -0,0 +1,11 @@ +from django.urls import path + +from . import views + +app_name = 'polls' +urlpatterns = [ + path('', views.IndexView.as_view(), name='index'), + path('/', views.DetailView.as_view(), name='detail'), + path('/results/', views.ResultsView.as_view(), name='results'), + path('/vote/', views.vote, name='vote'), +] \ No newline at end of file diff --git a/DevOps-Pipeline-Python/polls/views.py b/DevOps-Pipeline-Python/polls/views.py new file mode 100644 index 0000000..f65a793 --- /dev/null +++ b/DevOps-Pipeline-Python/polls/views.py @@ -0,0 +1,57 @@ +from django.http import HttpResponse, HttpResponseRedirect +from django.shortcuts import get_object_or_404, render +from django.urls import reverse +from django.views import generic +from django.utils import timezone + +from .models import Choice, Question + + +class IndexView(generic.ListView): + template_name = 'polls/index.html' + context_object_name = 'latest_question_list' + + def get_queryset(self): + """ + Return the last five published questions (not including those set to be + published in the future). + """ + return Question.objects.filter( + pub_date__lte=timezone.now() + ).order_by('-pub_date')[:5] + +def home(request): + return HttpResponse("Hello, world. Welcome to the home page! ") + + +class DetailView(generic.DetailView): + model = Question + template_name = 'polls/detail.html' + + def get_queryset(self): + """ + Excludes any questions that aren't published yet. + """ + return Question.objects.filter(pub_date__lte=timezone.now()) + +class ResultsView(generic.DetailView): + model = Question + template_name = 'polls/results.html' + +def vote(request, question_id): + question = get_object_or_404(Question, pk=question_id) + try: + selected_choice = question.choice_set.get(pk=request.POST['choice']) + except (KeyError, Choice.DoesNotExist): + # Redisplay the question voting form. + return render(request, 'polls/detail.html', { + 'question': question, + 'error_message': "You didn't select a choice.", + }) + else: + selected_choice.votes += 1 + selected_choice.save() + # Always return an HttpResponseRedirect after successfully dealing + # with POST data. This prevents data from being posted twice if a + # user hits the Back button. + return HttpResponseRedirect(reverse('polls:results', args=(question.id,))) \ No newline at end of file diff --git a/DevOps-Pipeline-Python/requirements.txt b/DevOps-Pipeline-Python/requirements.txt new file mode 100644 index 0000000..19368fa --- /dev/null +++ b/DevOps-Pipeline-Python/requirements.txt @@ -0,0 +1,2 @@ +Django==4.0.6 +python-decouple==3.6 \ No newline at end of file diff --git a/DevOps-Pipeline-Python/templates/base.html b/DevOps-Pipeline-Python/templates/base.html new file mode 100644 index 0000000..88697a5 --- /dev/null +++ b/DevOps-Pipeline-Python/templates/base.html @@ -0,0 +1,33 @@ + + + + + + + Polling {% block title %}{% endblock %} + + + +
+
+
+ {% block content %}{% endblock %} +
+
+
+ + \ No newline at end of file diff --git a/DevOps-Pipeline-Python/templates/polls/detail.html b/DevOps-Pipeline-Python/templates/polls/detail.html new file mode 100644 index 0000000..d3cf1c6 --- /dev/null +++ b/DevOps-Pipeline-Python/templates/polls/detail.html @@ -0,0 +1,18 @@ +{% extends 'base.html' %} + +{% block content %} + +

{{ question.question_text }}

+ +{% if error_message %}

{{ error_message }}

{% endif %} + +
+{% csrf_token %} +{% for choice in question.choice_set.all %} + +
+{% endfor %} + +
+ +{% endblock %} \ No newline at end of file diff --git a/DevOps-Pipeline-Python/templates/polls/index.html b/DevOps-Pipeline-Python/templates/polls/index.html new file mode 100644 index 0000000..e1b2443 --- /dev/null +++ b/DevOps-Pipeline-Python/templates/polls/index.html @@ -0,0 +1,20 @@ +{% extends 'base.html' %} + +{% block content %} +

Survey

+{% if latest_question_list %} + + {% for question in latest_question_list %} +
+
+

{{ question.question_text }}

+ Vote Now +
+
+ {% endfor %} + +{% else %} +

No polls are available.

+{% endif %} + +{% endblock %} \ No newline at end of file diff --git a/DevOps-Pipeline-Python/templates/polls/results.html b/DevOps-Pipeline-Python/templates/polls/results.html new file mode 100644 index 0000000..6610afc --- /dev/null +++ b/DevOps-Pipeline-Python/templates/polls/results.html @@ -0,0 +1,14 @@ +{% extends 'base.html' %} + +{% block content %} +

{{ question.question_text }}

+ +
    +{% for choice in question.choice_set.all %} +
  • {{ choice.choice_text }} -- {{ choice.votes }} vote{{ choice.votes|pluralize }}
    • +{% endfor %} +
+ +Vote again? + +{% endblock %} \ No newline at end of file