#161 Integrate fedora-messaging
Merged 9 months ago by jflory7. Opened 9 months ago by shraddhaag.
fedora-commops/ shraddhaag/fedora-happiness-packets use-fedora-messaging  into  master

file modified
+4 -2

@@ -13,6 +13,9 @@ 

  # Set correct DJANGO_SETTINGS_MODULE

  ENV DJANGO_SETTINGS_MODULE=happinesspackets.settings.dev

  

+ # Set the path for fedora-messaging configuration file

+ ENV FEDORA_MESSAGING_CONF=/app/config.toml

+ 

  # Copy project files into container

  COPY . /app

  

@@ -24,5 +27,4 @@ 

  RUN ./manage.py collectstatic --noinput

  

  # Expose Django port

- EXPOSE 8000 

- 

+ EXPOSE 8000

file added
+38

@@ -0,0 +1,38 @@ 

+ amqp_url = "amqp://user:pass@rabbitMq:5672/vhost"

+ 

+ publish_exchange = "amq.topic"

+ 

+ topic_prefix = ""

+ 

+ [tls]

+ ca_cert = "/etc/pki/tls/certs/ca-bundle.crt"

+ keyfile = "/my/client/key.pem"

+ certfile = "/my/client/cert.pem"

+ 

+ [client_properties]

+ app = "Fedora Happiness Packets"

+ 

+ [qos]

+ prefetch_size = 0

+ prefetch_count = 25

+ 

+ [log_config]

+ version = 1

+ disable_existing_loggers = true

+ 

+ [log_config.formatters.simple]

+ format = "[%(name)s %(levelname)s] %(message)s"

+ 

+ [log_config.handlers.console]

+ class = "logging.StreamHandler"

+ formatter = "simple"

+ stream = "ext://sys.stdout"

+ 

+ [log_config.loggers.fedora_messaging]

+ level = "INFO"

+ propagate = false

+ handlers = ["console"]

+ 

+ [log_config.root]

+ level = "WARNING"

+ handlers = ["console"]

file modified
+9

@@ -8,6 +8,15 @@ 

      links:

        - db

        - redis

+       - rabbitmq

+   rabbitmq:

+     image: rabbitmq:alpine

+     ports:

+       - "5672:5672"

+     environment:

+       RABBITMQ_DEFAULT_PASS: pass

+       RABBITMQ_DEFAULT_USER: user

+       RABBITMQ_DEFAULT_VHOST: vhost

    redis:

      image: redis:alpine

      ports:

@@ -0,0 +1,339 @@ 

+                     GNU GENERAL PUBLIC LICENSE

+                        Version 2, June 1991

+ 

+  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,

+  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

+  Everyone is permitted to copy and distribute verbatim copies

+  of this license document, but changing it is not allowed.

+ 

+                             Preamble

+ 

+   The licenses for most software are designed to take away your

+ freedom to share and change it.  By contrast, the GNU General Public

+ License is intended to guarantee your freedom to share and change free

+ software--to make sure the software is free for all its users.  This

+ General Public License applies to most of the Free Software

+ Foundation's software and to any other program whose authors commit to

+ using it.  (Some other Free Software Foundation software is covered by

+ the GNU Lesser General Public License instead.)  You can apply it to

+ your programs, too.

+ 

+   When we speak of free software, we are referring to freedom, not

+ price.  Our General Public Licenses are designed to make sure that you

+ have the freedom to distribute copies of free software (and charge for

+ this service if you wish), that you receive source code or can get it

+ if you want it, that you can change the software or use pieces of it

+ in new free programs; and that you know you can do these things.

+ 

+   To protect your rights, we need to make restrictions that forbid

+ anyone to deny you these rights or to ask you to surrender the rights.

+ These restrictions translate to certain responsibilities for you if you

+ distribute copies of the software, or if you modify it.

+ 

+   For example, if you distribute copies of such a program, whether

+ gratis or for a fee, you must give the recipients all the rights that

+ you have.  You must make sure that they, too, receive or can get the

+ source code.  And you must show them these terms so they know their

+ rights.

+ 

+   We protect your rights with two steps: (1) copyright the software, and

+ (2) offer you this license which gives you legal permission to copy,

+ distribute and/or modify the software.

+ 

+   Also, for each author's protection and ours, we want to make certain

+ that everyone understands that there is no warranty for this free

+ software.  If the software is modified by someone else and passed on, we

+ want its recipients to know that what they have is not the original, so

+ that any problems introduced by others will not reflect on the original

+ authors' reputations.

+ 

+   Finally, any free program is threatened constantly by software

+ patents.  We wish to avoid the danger that redistributors of a free

+ program will individually obtain patent licenses, in effect making the

+ program proprietary.  To prevent this, we have made it clear that any

+ patent must be licensed for everyone's free use or not licensed at all.

+ 

+   The precise terms and conditions for copying, distribution and

+ modification follow.

+ 

+                     GNU GENERAL PUBLIC LICENSE

+    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

+ 

+   0. This License applies to any program or other work which contains

+ a notice placed by the copyright holder saying it may be distributed

+ under the terms of this General Public License.  The "Program", below,

+ refers to any such program or work, and a "work based on the Program"

+ means either the Program or any derivative work under copyright law:

+ that is to say, a work containing the Program or a portion of it,

+ either verbatim or with modifications and/or translated into another

+ language.  (Hereinafter, translation is included without limitation in

+ the term "modification".)  Each licensee is addressed as "you".

+ 

+ Activities other than copying, distribution and modification are not

+ covered by this License; they are outside its scope.  The act of

+ running the Program is not restricted, and the output from the Program

+ is covered only if its contents constitute a work based on the

+ Program (independent of having been made by running the Program).

+ Whether that is true depends on what the Program does.

+ 

+   1. You may copy and distribute verbatim copies of the Program's

+ source code as you receive it, in any medium, provided that you

+ conspicuously and appropriately publish on each copy an appropriate

+ copyright notice and disclaimer of warranty; keep intact all the

+ notices that refer to this License and to the absence of any warranty;

+ and give any other recipients of the Program a copy of this License

+ along with the Program.

+ 

+ You may charge a fee for the physical act of transferring a copy, and

+ you may at your option offer warranty protection in exchange for a fee.

+ 

+   2. You may modify your copy or copies of the Program or any portion

+ of it, thus forming a work based on the Program, and copy and

+ distribute such modifications or work under the terms of Section 1

+ above, provided that you also meet all of these conditions:

+ 

+     a) You must cause the modified files to carry prominent notices

+     stating that you changed the files and the date of any change.

+ 

+     b) You must cause any work that you distribute or publish, that in

+     whole or in part contains or is derived from the Program or any

+     part thereof, to be licensed as a whole at no charge to all third

+     parties under the terms of this License.

+ 

+     c) If the modified program normally reads commands interactively

+     when run, you must cause it, when started running for such

+     interactive use in the most ordinary way, to print or display an

+     announcement including an appropriate copyright notice and a

+     notice that there is no warranty (or else, saying that you provide

+     a warranty) and that users may redistribute the program under

+     these conditions, and telling the user how to view a copy of this

+     License.  (Exception: if the Program itself is interactive but

+     does not normally print such an announcement, your work based on

+     the Program is not required to print an announcement.)

+ 

+ These requirements apply to the modified work as a whole.  If

+ identifiable sections of that work are not derived from the Program,

+ and can be reasonably considered independent and separate works in

+ themselves, then this License, and its terms, do not apply to those

+ sections when you distribute them as separate works.  But when you

+ distribute the same sections as part of a whole which is a work based

+ on the Program, the distribution of the whole must be on the terms of

+ this License, whose permissions for other licensees extend to the

+ entire whole, and thus to each and every part regardless of who wrote it.

+ 

+ Thus, it is not the intent of this section to claim rights or contest

+ your rights to work written entirely by you; rather, the intent is to

+ exercise the right to control the distribution of derivative or

+ collective works based on the Program.

+ 

+ In addition, mere aggregation of another work not based on the Program

+ with the Program (or with a work based on the Program) on a volume of

+ a storage or distribution medium does not bring the other work under

+ the scope of this License.

+ 

+   3. You may copy and distribute the Program (or a work based on it,

+ under Section 2) in object code or executable form under the terms of

+ Sections 1 and 2 above provided that you also do one of the following:

+ 

+     a) Accompany it with the complete corresponding machine-readable

+     source code, which must be distributed under the terms of Sections

+     1 and 2 above on a medium customarily used for software interchange; or,

+ 

+     b) Accompany it with a written offer, valid for at least three

+     years, to give any third party, for a charge no more than your

+     cost of physically performing source distribution, a complete

+     machine-readable copy of the corresponding source code, to be

+     distributed under the terms of Sections 1 and 2 above on a medium

+     customarily used for software interchange; or,

+ 

+     c) Accompany it with the information you received as to the offer

+     to distribute corresponding source code.  (This alternative is

+     allowed only for noncommercial distribution and only if you

+     received the program in object code or executable form with such

+     an offer, in accord with Subsection b above.)

+ 

+ The source code for a work means the preferred form of the work for

+ making modifications to it.  For an executable work, complete source

+ code means all the source code for all modules it contains, plus any

+ associated interface definition files, plus the scripts used to

+ control compilation and installation of the executable.  However, as a

+ special exception, the source code distributed need not include

+ anything that is normally distributed (in either source or binary

+ form) with the major components (compiler, kernel, and so on) of the

+ operating system on which the executable runs, unless that component

+ itself accompanies the executable.

+ 

+ If distribution of executable or object code is made by offering

+ access to copy from a designated place, then offering equivalent

+ access to copy the source code from the same place counts as

+ distribution of the source code, even though third parties are not

+ compelled to copy the source along with the object code.

+ 

+   4. You may not copy, modify, sublicense, or distribute the Program

+ except as expressly provided under this License.  Any attempt

+ otherwise to copy, modify, sublicense or distribute the Program is

+ void, and will automatically terminate your rights under this License.

+ However, parties who have received copies, or rights, from you under

+ this License will not have their licenses terminated so long as such

+ parties remain in full compliance.

+ 

+   5. You are not required to accept this License, since you have not

+ signed it.  However, nothing else grants you permission to modify or

+ distribute the Program or its derivative works.  These actions are

+ prohibited by law if you do not accept this License.  Therefore, by

+ modifying or distributing the Program (or any work based on the

+ Program), you indicate your acceptance of this License to do so, and

+ all its terms and conditions for copying, distributing or modifying

+ the Program or works based on it.

+ 

+   6. Each time you redistribute the Program (or any work based on the

+ Program), the recipient automatically receives a license from the

+ original licensor to copy, distribute or modify the Program subject to

+ these terms and conditions.  You may not impose any further

+ restrictions on the recipients' exercise of the rights granted herein.

+ You are not responsible for enforcing compliance by third parties to

+ this License.

+ 

+   7. If, as a consequence of a court judgment or allegation of patent

+ infringement or for any other reason (not limited to patent issues),

+ conditions are imposed on you (whether by court order, agreement or

+ otherwise) that contradict the conditions of this License, they do not

+ excuse you from the conditions of this License.  If you cannot

+ distribute so as to satisfy simultaneously your obligations under this

+ License and any other pertinent obligations, then as a consequence you

+ may not distribute the Program at all.  For example, if a patent

+ license would not permit royalty-free redistribution of the Program by

+ all those who receive copies directly or indirectly through you, then

+ the only way you could satisfy both it and this License would be to

+ refrain entirely from distribution of the Program.

+ 

+ If any portion of this section is held invalid or unenforceable under

+ any particular circumstance, the balance of the section is intended to

+ apply and the section as a whole is intended to apply in other

+ circumstances.

+ 

+ It is not the purpose of this section to induce you to infringe any

+ patents or other property right claims or to contest validity of any

+ such claims; this section has the sole purpose of protecting the

+ integrity of the free software distribution system, which is

+ implemented by public license practices.  Many people have made

+ generous contributions to the wide range of software distributed

+ through that system in reliance on consistent application of that

+ system; it is up to the author/donor to decide if he or she is willing

+ to distribute software through any other system and a licensee cannot

+ impose that choice.

+ 

+ This section is intended to make thoroughly clear what is believed to

+ be a consequence of the rest of this License.

+ 

+   8. If the distribution and/or use of the Program is restricted in

+ certain countries either by patents or by copyrighted interfaces, the

+ original copyright holder who places the Program under this License

+ may add an explicit geographical distribution limitation excluding

+ those countries, so that distribution is permitted only in or among

+ countries not thus excluded.  In such case, this License incorporates

+ the limitation as if written in the body of this License.

+ 

+   9. The Free Software Foundation may publish revised and/or new versions

+ of the General Public License from time to time.  Such new versions will

+ be similar in spirit to the present version, but may differ in detail to

+ address new problems or concerns.

+ 

+ Each version is given a distinguishing version number.  If the Program

+ specifies a version number of this License which applies to it and "any

+ later version", you have the option of following the terms and conditions

+ either of that version or of any later version published by the Free

+ Software Foundation.  If the Program does not specify a version number of

+ this License, you may choose any version ever published by the Free Software

+ Foundation.

+ 

+   10. If you wish to incorporate parts of the Program into other free

+ programs whose distribution conditions are different, write to the author

+ to ask for permission.  For software which is copyrighted by the Free

+ Software Foundation, write to the Free Software Foundation; we sometimes

+ make exceptions for this.  Our decision will be guided by the two goals

+ of preserving the free status of all derivatives of our free software and

+ of promoting the sharing and reuse of software generally.

+ 

+                             NO WARRANTY

+ 

+   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY

+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN

+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES

+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED

+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS

+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE

+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,

+ REPAIR OR CORRECTION.

+ 

+   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING

+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR

+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,

+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING

+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED

+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY

+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER

+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE

+ POSSIBILITY OF SUCH DAMAGES.

+ 

+                      END OF TERMS AND CONDITIONS

+ 

+             How to Apply These Terms to Your New Programs

+ 

+   If you develop a new program, and you want it to be of the greatest

+ possible use to the public, the best way to achieve this is to make it

+ free software which everyone can redistribute and change under these terms.

+ 

+   To do so, attach the following notices to the program.  It is safest

+ to attach them to the start of each source file to most effectively

+ convey the exclusion of warranty; and each file should have at least

+ the "copyright" line and a pointer to where the full notice is found.

+ 

+     <one line to give the program's name and a brief idea of what it does.>

+     Copyright (C) <year>  <name of author>

+ 

+     This program is free software; you can redistribute it and/or modify

+     it under the terms of the GNU General Public License as published by

+     the Free Software Foundation; either version 2 of the License, or

+     (at your option) any later version.

+ 

+     This program is distributed in the hope that it will be useful,

+     but WITHOUT ANY WARRANTY; without even the implied warranty of

+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+     GNU General Public License for more details.

+ 

+     You should have received a copy of the GNU General Public License along

+     with this program; if not, write to the Free Software Foundation, Inc.,

+     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

+ 

+ Also add information on how to contact you by electronic and paper mail.

+ 

+ If the program is interactive, make it output a short notice like this

+ when it starts in an interactive mode:

+ 

+     Gnomovision version 69, Copyright (C) year name of author

+     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.

+     This is free software, and you are welcome to redistribute it

+     under certain conditions; type `show c' for details.

+ 

+ The hypothetical commands `show w' and `show c' should show the appropriate

+ parts of the General Public License.  Of course, the commands you use may

+ be called something other than `show w' and `show c'; they could even be

+ mouse-clicks or menu items--whatever suits your program.

+ 

+ You should also get your employer (if you work as a programmer) or your

+ school, if any, to sign a "copyright disclaimer" for the program, if

+ necessary.  Here is a sample; alter the names:

+ 

+   Yoyodyne, Inc., hereby disclaims all copyright interest in the program

+   `Gnomovision' (which makes passes at compilers) written by James Hacker.

+ 

+   <signature of Ty Coon>, 1 April 1989

+   Ty Coon, President of Vice

+ 

+ This General Public License does not permit incorporating your program into

+ proprietary programs.  If your program is a subroutine library, you may

+ consider it more useful to permit linking proprietary applications with the

+ library.  If this is what you want to do, use the GNU Lesser General

+ Public License instead of this License.

@@ -0,0 +1,1 @@ 

+ A schema package for Fedora Happiness Packets

@@ -0,0 +1,15 @@ 

+ # Copyright (C) 2018  Red Hat, Inc.

+ #

+ # This program is free software; you can redistribute it and/or modify

+ # it under the terms of the GNU General Public License as published by

+ # the Free Software Foundation; either version 2 of the License, or

+ # (at your option) any later version.

+ #

+ # This program is distributed in the hope that it will be useful,

+ # but WITHOUT ANY WARRANTY; without even the implied warranty of

+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ # GNU General Public License for more details.

+ #

+ # You should have received a copy of the GNU General Public License along

+ # with this program; if not, write to the Free Software Foundation, Inc.,

+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

@@ -0,0 +1,67 @@ 

+ from fedora_messaging import message

+ 

+ 

+ class BaseMessage(message.Message):

+ 

+     def __str__(self):

+         return "{sender} sent a happiness packet to {recipient}".format(

+             sender=self.sender,

+             recipient=self.recipient

+         )

+ 

+     @property

+     def summary(self):

+         if self.sender != "Anonymous":

+             return "{sender}, {recipient}".format(

+                 sender=self.sender,

+                 recipient=self.recipient

+             )

+         else:

+             return self.recipient

+ 

+     @property

+     def sender(self):

+         return 'Message did not implement "sender" property'

+ 

+     @property

+     def recipient(self):

+         return 'Message did not implement "recipient" property'

+ 

+     @property

+     def app_icon(self):

+         return "https://pagure.io/fedora-commops/fedora-happiness-packets/blob/master/f/assets/images/logo.png"

+ 

+     @property

+     def usernames(self):

+         """List of users affected by the action that generated this message."""

+         if self.sender != "Anonymous":

+             return [self.sender, self.recipient]

+         else:

+             return [self.recipient,]

+ 

+ 

+ class MessageV1(BaseMessage):

+ 

+     body_schema = {

+         "id": "https://fedoraproject.org/message-schema/happiness_packet",

+         "$schema": "http://json-schema.org/draft-04/schema#",

+         "description": "Schema for happinesspacket sent",

+         "type": "object",

+         "properties": {

+             "id":{"type": "string"},

+             "sender": {"type": "string"},

+             "recipient": {"type": "string"}

+         },

+         "required": ["id", "sender", "recipient"]

+     }

+ 

+     @property

+     def sender(self):

+         """The sender's name"""

+         return self.body["sender"]

+ 

+     @property

+     def recipient(self):

+         """The recipient's name"""

+         return self.body["recipient"]

+ 

@@ -0,0 +1,15 @@ 

+ # Copyright (C) 2018  Red Hat, Inc.

+ #

+ # This program is free software; you can redistribute it and/or modify

+ # it under the terms of the GNU General Public License as published by

+ # the Free Software Foundation; either version 2 of the License, or

+ # (at your option) any later version.

+ #

+ # This program is distributed in the hope that it will be useful,

+ # but WITHOUT ANY WARRANTY; without even the implied warranty of

+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ # GNU General Public License for more details.

+ #

+ # You should have received a copy of the GNU General Public License along

+ # with this program; if not, write to the Free Software Foundation, Inc.,

+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

@@ -0,0 +1,93 @@ 

+ import unittest

+ 

+ from jsonschema import ValidationError

+ from .. import schema

+ 

+ 

+ class MessageV1Tests(unittest.TestCase):

+ 

+     msg_class = schema.MessageV1

+ 

+     def setUp(self):

+         self.unknown_sender_message = {

+             "id": "RandomString",

+             "sender": "Anonymous",

+             "recipient": "John Doe"

+         }

+         self.known_sender_message = {

+             "id": "RandomString",

+             "sender": "John Doe",

+             "recipient": "John Doe v2"

+         }

+ 

+     def test_unknown_sender_message(self):

+         """

+         Assert the message schema validates a message with an unknown sender.

+         """

+         message = self.msg_class(body=self.unknown_sender_message)

+ 

+         message.validate()

+ 

+     def test_known_sender_message(self):

+         """Assert the message schema validates with a known sender."""

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         message.validate()

+ 

+     def test_str_for_known_sender_message(self):

+         """Assert __str__ produces a human-readable message for a message with all fields."""

+         expected_str = "John Doe sent a happiness packet to John Doe v2"

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         message.validate()

+         self.assertEqual(expected_str, str(message))

+ 

+     def test_str_for_unknown_sender_message(self):

+         """Assert __str__ produces a human-readable message for a unknown sender message."""

+         expected_str = "Anonymous sent a happiness packet to John Doe"

+         message = self.msg_class(body=self.unknown_sender_message)

+ 

+         message.validate()

+         self.assertEqual(expected_str, str(message))

+ 

+     def test_summary_for_known_sender_message(self):

+         """Assert the summary matches the sender and then the recipient for a known sender message."""

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         self.assertEqual("John Doe, John Doe v2", message.summary)

+     

+     def test_summary_for_unknown_sender_message(self):

+         """Assert the summary matches the recipient for a unknown sender message."""

+         message = self.msg_class(body=self.unknown_sender_message)

+ 

+         self.assertEqual("John Doe", message.summary)

+ 

+     def test_sender(self):

+         """Assert the message provides a "sender" attribute."""

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         self.assertEqual("John Doe", message.sender)

+ 

+     def test_recipient(self):

+         """Assert the message provides a "recipient" attribute."""

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         self.assertEqual("John Doe v2", message.recipient)

+ 

+     def test_usernames_for_known_sender_message(self):

+         """Assert the message provides a "usernames" attribute in known sender message."""

+         message = self.msg_class(body=self.known_sender_message)

+ 

+         self.assertEqual(['John Doe', 'John Doe v2'], message.usernames)

+     

+     def test_usernames_for_unknown_sender_message(self):

+         """Assert the message provides a "usernames" attribute in unknown sender message."""

+         message = self.msg_class(body=self.unknown_sender_message)

+         

+         self.assertEqual(['John Doe',], message.usernames)

+ 

+     def test_packages(self):

+         """Assert the message provides a "packages" attribute."""

+         message = self.msg_class(body=self.known_sender_message)

+         

+         self.assertEqual([], message.packages) 

\ No newline at end of file

@@ -0,0 +1,5 @@ 

+ [bdist_wheel]

+ universal = 1

+ 

+ [flake8]

+ max-line-length = 100 

\ No newline at end of file

@@ -0,0 +1,44 @@ 

+ import os

+ 

+ from setuptools import setup, find_packages

+ 

+ 

+ here = os.path.abspath(os.path.dirname(__file__))

+ with open(os.path.join(here, "README")) as fd:

+     README = fd.read()

+ 

+ 

+ setup(

+     name="happinesspacket_schema",

+     version="0.1.2",

+     description="A schema package for Fedora Happiness Packets",

+     long_description=README,

+     url="https://pagure.io/fedora-commops/fedora-happiness-packets",

+     # Possible options are at https://pypi.python.org/pypi?%3Aaction=list_classifiers

+     classifiers=[

+         "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",

+         "Operating System :: POSIX :: Linux",

+         "Programming Language :: Python :: 2",

+         "Programming Language :: Python :: 2.7",

+         "Programming Language :: Python :: 3",

+         "Programming Language :: Python :: 3.4",

+         "Programming Language :: Python :: 3.5",

+         "Programming Language :: Python :: 3.6",

+         "Programming Language :: Python :: 3.7",

+     ],

+     license="GPLv2+",

+     maintainer="Fedora Infrastructure Team",

+     maintainer_email="infrastructure@lists.fedoraproject.org",

+     platforms=["Fedora", "GNU/Linux"],

+     keywords="fedora",

+     packages=find_packages(exclude=("happinesspacket_schema.tests", "happinesspacket_schema.tests.*")),

+     include_package_data=True,

+     zip_safe=False,

+     install_requires=["fedora_messaging"],

+     test_suite="happinesspacket_schema.tests",

+     entry_points={

+         "fedora.messages": [

+             "happinesspacket.messageV1=happinesspacket_schema.schema:MessageV1",

+         ]

+     },

+ )

@@ -20,8 +20,12 @@ 

  from .forms import MessageSendForm, MessageRecipientForm

  from .models import Message, BLACKLIST_HMAC_SALT, BlacklistedEmail, strip_email

  

- logger = logging.getLogger(__name__)

+ from fedora_messaging.api import publish

+ from fedora_messaging.config import conf

+ from fedora_messaging.exceptions import PublishReturned, ConnectionException

+ from happinesspacket_schema.schema import MessageV1

  

+ logger = logging.getLogger(__name__)

  

  class MessageSearchView(SearchView):

      template_name = 'search/search.html'

@@ -128,6 +132,22 @@ 

              return self.render_to_response({'already_confirmed': True})

  

          message.send_to_recipient(self.request.is_secure(), self.request.get_host())

+ 

+         sender_name = self.request.user.username if message.sender_named else "Anonymous"

+         message = MessageV1(

+             topic="happinesspacket.send",

+             body={

+                 "id": message.identifier,

+                 "sender": sender_name,

+                 "recipient": message.recipient_name

+             }    	         

+         )

+         try:

+             publish(message)

+         except PublishReturned:

+             return self.render_to_response({'publish_returned': True})

+         except ConnectionException:

+             return self.render_to_response({'connection_exception': True})

          return HttpResponseRedirect(reverse('messaging:sender_confirmed'))

  

  

@@ -149,10 +169,6 @@ 

  

      def form_valid(self, form):

          form.save()

-         msg = self.get_queryset()[0]

-         if msg.sender_approved_public and msg.recipient_approved_public:

-             sender_name = msg.sender_name if msg.sender_approved_public_named else "Anonymous"

-             recipient_name = msg.recipient_name if msg.recipient_approved_public_named else "Anonymous"

          messages.success(self.request, "Your choices have been saved.")

          return HttpResponseRedirect(self.request.path)

  

file modified
+3 -1

@@ -6,7 +6,7 @@ 

  django-crispy-forms==1.6.0

  django-model-utils==2.4

  dogslow==0.9.7                       # For logging details about very slow requests

- six==1.10.0                          # Dependency of django-extensions

+ six>=1.11.0                          # Dependency of django-extensions

  

  # Basic Python libraries

  Unipath==1.1          # Better path handling

@@ -33,6 +33,8 @@ 

  factory-boy==2.9.2

  opbeat==3.3

  mozilla-django-oidc==1.0.0

+ fedora-messaging>=1.4.0

+ happinesspacket-schema>=0.1.2

  celery[redis]==4.2.1

  django-celery-email==2.0.1

  psycopg2==2.7.5 # PostgreSQL driver

@@ -14,6 +14,14 @@ 

          <div class="alert alert-info">

              You already confirmed this message.

          </div>

+     {% elif publish_returned %}

+         <div class="alert alert-info">

+             The message could not be sent because the broker rejected the message. Please try again later!

+         </div>

+     {% elif connection_exception %}

+         <div class="alert alert-info">

+             The message could not be sent because an error in connection occurred before the broker could send a publish confirmation. Please try again later. 

+         </div>

      {% endif %}

  

  {% endblock content %}

This PR integrates fedora-messaging in our project.

This commit includes:

  1. Adds fedora-messaging and happinesspackets-schema as a dependency in base.py
  2. Sets env variable to fedora-messaging config file in Dockerfile
  3. Adds config.toml [configuration file for fedora-messaging] to project's root directory
  4. Instructions to build a container for RabbitMQ in docker-compose.yml
  5. Adds happinesspacket_schema_package which houses the schema and tests.
  6. Configured MessageSenderConfirmationView to post messages to the broker.

To see the change in action:

  1. Build the container again.
  2. In a new terminal access the shell, and run fedora-messaging consume --callback=fedora_messaging.example:printer
  3. Send a happiness packet, confirm the packet and observe the message being emitted in the terminal listening for the messages.

Task left to be done:

Currently the name of the recipient is send to the broker. Instead, the username of the recipient should be sent as that will be needed to assign them the badge.
Configure a way to get the username of the recipient from the email input by the user. [WIP]

Hi @jflory7 can you please look into this when you have time? :smile:
Eagerly waiting for your feedback :)

PS: I'm sorry about not making it an incremental upgrade, I had too many commits during development thus I squashed them all together into one. I sincerely apologise if this makes it hard to review.

Metadata Update from @jflory7:
- Pull-request tagged with: needs testing, new change, type - backend, type - fedora-messaging, type - summer coding
- Request assigned

9 months ago

@shraddhaag Thanks for this PR!! Super exciting to see this work. I won't have time for a detailed review until later, but I'll try to round up a couple of others more familiar with fedora-messaging to take a look at your changes.

@jcline @abompard @cverna If any of you have time for a fedmsg => fedora-messaging PR review, your insight here is super helpful. :grinning:

rebased onto 68150bdc8ce9b29f160964b0563ae45264b04752

9 months ago

rebased onto 177977ebaf334a63132e94f02e25ea1be8283419

9 months ago

The id needs to be unique. I think "https://fedoraproject.org/message-schema/happiness_packet" would be fine if this is the only message the app sends.

Minor nitpik, but this indentation should line up with "properties"

This is the name of the Python package of the schema, so it'd probably be best to call it "happinesspacket_messages" or "fedora_happinesspacket_messages" so it's clear it's not the happinesspacket application itself.

Don't forget to update the URL to this repo :grinning:

This call can raise a couple different exceptions[0] that you'll want to handle here. Since this is happening in a HTTP endpoint, handling them all should be pretty straightforward.

  1. fedora_messaging.exceptions.PublishReturned - This exception occurs when the broker is up, but for some reason cannot accept the message (no more disk space, for example). The best thing to do here is probably send the client a HTTP 503 Service Unavailable[1] since the broker is in trouble.

  2. fedora_messaging.exceptions.ConnectionException - This happens if we can't even connect to the broker after the configured number of connection attempts. It might be being rebooted, or there's a network partition, but at any rate we can't hang around forever waiting so we should again send a HTTP 503 to inform the user to try again later.

For both these, if this is a user-facing page (I don't know much about this app) you should be able to make some sort of HTML page that tells the user more than the generic HTTP 503 page. Something like "The message could not be sent because {{ reason }}, please try again later!".

The final exception, fedora_messaging.exceptions.ValidationError, is not one you need to handle. It's there to let the developer (you) know if they're sending a message that isn't valid.

[0] https://fedora-messaging.readthedocs.io/en/stable/api.html#fedora_messaging.api.publish
[1] https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

You'll probably not want to pin this exact version. "fedora-messaging>=1.4.0" should be fine.

I can't comment inline on the binary files, but you don't want to check in the files from dist/ (Happinesspacket-1.0.0-py2.py3-none-any.whl and the tar.gz). Those are build artifacts generated with "python setup.py sdist bdist_wheel".

rebased onto cf72fadba1d90baff15fce9e4c47593928466694

9 months ago

rebased onto fc2de206685256f89a8884e506ad1353b5dd5dcf

9 months ago

Hi @jcline
Thank you for the detailed review! :)
I've integrated all the changes you asked.
Could you please find the time to review the changes?

I've also uploaded the package on PyPI which can be found here with all the changes integrated.
I'm working on submitting an RPM package for it to Fedora and EPEL.

rebased onto f00dd81dceb3275b8ba6a655ab6680b35e61b5cc

9 months ago

A completely equivalent way to write this if/else would be:

sender_name = self.request.user.username if message.sender_name else "Anonymous"

It's totally personal taste for style, and I have no opinion, but just in case you didn't know.

Since this is only used later in the construction of the MessageV1 class, it'd probably be better to just do "recipient": message.recipient_name when you make the message. While there's nothing wrong with this code, it's not necessary and made me look around for where the recipient name got modified.

The Python namespace you're using is "happinesspacket_schema", so it would be best to use that name here. I assume this works, but it's not common for the name of the package to not match the Python namespace.

There's actually a (probably not well-documented) version of this that ships with fedora-messaging in the "fedora_messaging.example" module. You should be able to run it with the CLI fedora-messaging ships with by running "fedora-messaging consume --callback=fedora_messaging.example:printer". You can specify the configuration with the --conf flag or with the FEDORA_MESSAGING_CONF environment variable.

@shraddhaag , looks good :sparkles: :cake:

I left a few minor notes, and I've not actually tested the code, but it generally looks right to me. @jflory7, back to you!

rebased onto 3c2dee2067c90e1546ce8d8050e191c195c5a17c

9 months ago

rebased onto 759b3de2ab9ef61b1a30b100520c2e8c3e53cf50

9 months ago

@jcline Thank you for the review again! :)
I've made the changes as asked. The package on PyPI can be found here.

@jflory7 Super excited for the review :)
I'm working on updating the documentation meanwhile.

rebased onto 3e91392

9 months ago

Task left to be done:
Currently the name of the recipient is send to the broker. Instead, the username of the recipient should be sent as that will be needed to assign them the badge.
Configure a way to get the username of the recipient from the email input by the user. [WIP]

As an afterthought, this could be done after #127 is completed. If using FAS to search for accounts, it will be easier to get the recipient's username.

@shraddhaag, do you want to open a new ticket to track this?

@jflory7 Super excited for the review :)
I'm working on updating the documentation meanwhile.

I just tested this out locally and it works exactly as described. :tada: :tada: This is so awesome, I wasn't expecting for this to be done so quickly. Next week, we'll have to see if we can get this pushed to staging. :smile:

Thanks again @shraddhaag, merging! :clapper:

Metadata Update from @jflory7:
- Pull-request untagged with: needs testing

9 months ago

Pull-Request has been merged by jflory7

9 months ago

As an afterthought, this could be done after #127 is completed. If using FAS to search for accounts, it will be easier to get the recipient's username.
@shraddhaag, do you want to open a new ticket to track this?

I have been tracking that issue for the same reason and trying to figure out a way myself for it.
I'll open an issue so that it's easier to track things and keep everyone in the loop.

I just tested this out locally and it works exactly as described. 🎉 🎉 This is so awesome, I wasn't expecting for this to be done so quickly. Next week, we'll have to see if we can get this pushed to staging. 😄
Thanks again @shraddhaag, merging! 🎬

Thank you so much @jflory7 Extremely glad I could get this done :)
I'm on board for staging :)