Issue 4380 - Add Mock Crowdin API and Sync Test

tests/mock_api.py

Index: tests/mock_api.py
===================================================================
new file mode 100644
--- /dev/null
+++ b/tests/mock_api.py
@@ -0,0 +1,127 @@
+from flask import Flask, send_from_directory, jsonify, request

[Sebastian Noack, 2016/10/05 12:06:16]

I wonder whether using Flask here would be overkill. I know, the additional
dependency would only be for the tests. But IMO it wouldn't be much (if any)
more complicated to use Werkzeug (http://werkzeug.pocoo.org/docs/tutorial)
directly. It is the low-level web framework which Flask is implemented on top.
Also note that the CMS is already using Werkzeug (optionally) for its own
development server. What do you think?

[Sebastian Noack, 2016/10/05 12:06:16]

The name of this module is a little to generic, given that this is going to land
in the CMS, where CrowdIn integration isn't the core feature. How about calling
it "crowdin_mock_api" (or some other name that contains "crowdin")?

[Jon Sonesen, 2016/10/05 14:38:13]

I am aware that Flask is implemented on top of Werkzeug, my argument here is
that the code
I write in making my own wsgi app with Werkzeug is already implemented by Flask,
additionally the Flask team will be maintaining that code. The alternative is
that I reinvent the
wheel that Flask has already invented. Currently this app is super small, and
easy to read and maintain.
However if you feel strongly about this I can just implement it on top of
werkzeug.

[Jon Sonesen, 2016/10/05 14:38:13]

yes that is a good point and I will do so.

[Sebastian Noack, 2016/10/05 16:36:44]

Werkzeug might not be as low-level as you think. It just has a somewhat
different flavor, e.g instead of using the route() decorator, you use Map and
Rule objects: http://werkzeug.pocoo.org/docs/routing/

Flask does more magic and has more shortcuts, keeping the code a little more
concise, but not necessarily easier to understand. And you are definitely not
"reinventing the wheel" if you use Werkzeug directly here. In particular if you
have to figure out what is happening under the hood, either to debug an issue or
because a given API doesn't seem powerful enough, each layer you have to go
through makes it more complicated. Note that for those reasons, we avoided Flask
so far. However, it doesn't matter as much here, since it is just test code.

[Jon Sonesen, 2016/10/08 02:21:40]

I see, I think that if you are okay with it that sticking with what we have
would be my preferred option.
Also, how would going the werkzeug route affect the list of tuples solution for
logging the requests made by the translate module?

+
+app = Flask(__name__)
+app.request_data = {}

[Jon Sonesen, 2016/10/05 03:54:49]

This is my preliminary solution to the logging problem, this way it is  a simple
dict which can be accessed by the test suite. The, it can be iterated over to
make assertions

[Vasily Kuznetsov, 2016/10/05 14:44:42]

Perhaps it would make more sense to make this a list of tuples `(url, data)`
instead to be able to see in which order the requests were made and take care of
the possibility that we'll have several requests to the same url.

[Jon Sonesen, 2016/10/08 02:21:40]

I agree here. Will do!

+
+
+@app.before_request
+def log_request_info():
+    data = request.get_data()
+    if data:
+        app.request_data[request.url] = data
+
+
+@app.route('/api/project/test/info', methods=['GET'])
+def info():
+    return jsonify(
+        {
+            'languages': [
+                {
+                    'name': 'German',
+                    'code': 'de',
+                    'can_translate': 1,
+                    'can_approve': 1,
+
+                },
+                {
+                    'name': 'English',
+                    'code': 'en',
+                    'can_translate': 1,
+                    'can_approve': 1,
+
+                },
+
+            ],
+            'files': [
+                {
+                    'node_type': 'directory',
+                    'name': 'en',
+                    'files': [
+                        {
+                            'node_type': 'file',
+                            'name': 'translate.json',
+                            'created': '2016-09-26 08:30:07',
+                            'last_updated': '2016-09-26 08:30:08',
+                            'last_accessed': None,
+                            'last_revision': '1'
+                        },
+                    ]
+                },
+                {
+                    'node_type': 'directory',
+                    'name': 'de',
+                    'files': [
+                        {
+                            'node_type': 'file',
+                            'name': 'translate.json',
+                            'created': '2016-09-26 08:30:07',
+                            'last_updated': '2016-09-26 08:30:08',
+                            'last_accessed': None,
+                            'last_revision': '1'
+                        }
+                    ]
+                }
+            ]
+        }
+    )
+
+
+@app.route('/api/project/test/supported-languages', methods=['GET'])
+def supported_langs():
+    return jsonify(
+        [
+            {
+                'name': 'German',
+                'crowdin_code': 'de',
+                'editor_code': 'de',
+                'iso_639_1': 'de',
+                'iso_639_3': 'deu',
+                'locale': 'de-DE'
+            },
+            {
+                'name': 'English',
+                'crowdin_code': 'en',
+                'editor_code': 'en',
+                'iso_639_1': 'en',
+                'iso_639_3': 'eng',
+                'locale': 'en-US'
+            },
+        ]
+    )
+
+
+@app.route('/api/project/test/add-file', methods=['POST'])
+def add_file():
+    app.string = request.get_data()
+    return jsonify()
+
+
+@app.route('/api/project/test/upload-translation', methods=['POST'])
+def upload_translation():
+    return jsonify()
+
+
+@app.route('/api/project/test/delete-directory', methods=['POST'])
+def delete_directory():
+    return jsonify()
+
+
+@app.route('/api/project/test/delete-file', methods=['POST'])
+def delete_file():
+    return jsonify()
+
+
+@app.route('/api/project/test/export', methods=['GET'])
+def export():
+    return jsonify(
+            {
+                'success': {
+                    'status': 'skipped'
+                }
+            },
+    )
+
+
+@app.route('/api/project/test/download/all.zip', methods=['GET'])
+def get_zip():
+    return send_from_directory('', 'all.zip')