Skip to content

Fix/project snippets #979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 18, 2019
Merged

Fix/project snippets #979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e104e21
fix(projects): adjust snippets to match the API
max-wittig Dec 18, 2019
0952c55
test: add project snippet tests
max-wittig Dec 18, 2019
ac0ea91
test: adjust functional tests for project snippets
max-wittig Dec 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added gitlab/tests/objects/__init__.py
View file
Open in desktop
Empty file.
140 changes: 140 additions & 0 deletions gitlab/tests/objects/test_projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
import unittest
import gitlab
import os
import pickle
import tempfile
import json
import unittest
import requests
from gitlab import * # noqa
from gitlab.v4.objects import * # noqa
from httmock import HTTMock, urlmatch, response # noqa


headers = {"content-type": "application/json"}


class TestProjectSnippets(unittest.TestCase):
def setUp(self):
self.gl = Gitlab(
"http://localhost",
private_token="private_token",
ssl_verify=True,
api_version=4,
)

def test_list_project_snippets(self):
title = "Example Snippet Title"
visibility = "private"

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/snippets",
method="get",
)
def resp_list_snippet(url, request):
content = """[{
"title": "%s",
"description": "More verbose snippet description",
"file_name": "example.txt",
"content": "source code with multiple lines",
"visibility": "%s"}]""" % (
title,
visibility,
)
content = content.encode("utf-8")
return response(200, content, headers, None, 25, request)

with HTTMock(resp_list_snippet):
snippets = self.gl.projects.get(1, lazy=True).snippets.list()
self.assertEqual(len(snippets), 1)
self.assertEqual(snippets[0].title, title)
self.assertEqual(snippets[0].visibility, visibility)

def test_get_project_snippets(self):
title = "Example Snippet Title"
visibility = "private"

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/snippets/1",
method="get",
)
def resp_get_snippet(url, request):
content = """{
"title": "%s",
"description": "More verbose snippet description",
"file_name": "example.txt",
"content": "source code with multiple lines",
"visibility": "%s"}""" % (
title,
visibility,
)
content = content.encode("utf-8")
return response(200, content, headers, None, 25, request)

with HTTMock(resp_get_snippet):
snippet = self.gl.projects.get(1, lazy=True).snippets.get(1)
self.assertEqual(snippet.title, title)
self.assertEqual(snippet.visibility, visibility)

def test_create_update_project_snippets(self):
title = "Example Snippet Title"
visibility = "private"

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/snippets",
method="put",
)
def resp_update_snippet(url, request):
content = """{
"title": "%s",
"description": "More verbose snippet description",
"file_name": "example.txt",
"content": "source code with multiple lines",
"visibility": "%s"}""" % (
title,
visibility,
)
content = content.encode("utf-8")
return response(200, content, headers, None, 25, request)

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/snippets",
method="post",
)
def resp_create_snippet(url, request):
content = """{
"title": "%s",
"description": "More verbose snippet description",
"file_name": "example.txt",
"content": "source code with multiple lines",
"visibility": "%s"}""" % (
title,
visibility,
)
content = content.encode("utf-8")
return response(200, content, headers, None, 25, request)

with HTTMock(resp_create_snippet, resp_update_snippet):
snippet = self.gl.projects.get(1, lazy=True).snippets.create(
{
"title": title,
"file_name": title,
"content": title,
"visibility": visibility,
}
)
self.assertEqual(snippet.title, title)
self.assertEqual(snippet.visibility, visibility)
title = "new-title"
snippet.title = title
snippet.save()
self.assertEqual(snippet.title, title)
self.assertEqual(snippet.visibility, visibility)
7 changes: 5 additions & 2 deletions gitlab/v4/objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3667,8 +3667,11 @@ class ProjectSnippetManager(CRUDMixin, RESTManager):
_path = "/projects/%(project_id)s/snippets"
_obj_cls = ProjectSnippet
_from_parent_attrs = {"project_id": "id"}
_create_attrs = (("title", "file_name", "code"), ("lifetime", "visibility"))
_update_attrs = (tuple(), ("title", "file_name", "code", "visibility"))
_create_attrs = (("title", "file_name", "content", "visibility"), ("description",))
_update_attrs = (
tuple(),
("title", "file_name", "content", "visibility", "description"),
)


class ProjectTrigger(SaveMixin, ObjectDeleteMixin, RESTObject):
Expand Down
2 changes: 1 addition & 1 deletion tools/python_test_v4.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@
{
"title": "snip1",
"file_name": "foo.py",
"code": "initial content",
"content": "initial content",
"visibility": gitlab.v4.objects.VISIBILITY_PRIVATE,
}
)
Expand Down