Merge lp:~james-w/vostok/add-sourcepackagerelease-model into lp:vostok

[James Westby]

Add a SourcePackageRelease model class.

Then the bare minimum of a SourcePackageRelease class.

Thanks,

James

[Michael Hudson-Doyle (mwhudson)]

58 + # TODO: uploader, signer

This makes me go, "hm, yes, how are we going to represent people?"

We should certainly validate the format of the package name and version number.

Is there some way to get django to generate a schema that has a default of now for date_uploaded?

+# XXX: how much should we .save() the models?

This is a fun issue too: if you're not careful you can create objects that violate database constraints because they are never flushed to the database. OTOH, you don't want to hit the database because that slows the tests down. I don't think there's a happy answer here, although maybe it's less of an issue in vostok compared Launchpad because we're using an automatically generated schema with less exotic constraints.

The code looks inoffensive enough, it just prompts some more questions :-)

[James Westby (james-w)]

On Fri, 04 Jun 2010 04:57:22 -0000, Michael Hudson <email address hidden> wrote:
> 58 + # TODO: uploader, signer
>
> This makes me go, "hm, yes, how are we going to represent people?"

Django has a built-in, apparently extensible, Person model. It has the
nasty separation between first/last name, but perhaps we could ignore that.

> We should certainly validate the format of the package name and version number.

Yes, unfortunately "validators" which are the new way to do this are
only in Django 1.2, which isn't in lucid. I'll look around for addons or
similar that were used before to do something similar.

> Is there some way to get django to generate a schema that has a default of now for date_uploaded?

Yes, it's an option when creating the field. It's not a default though,
it's apparently not something you can set if you use the option, so I
went with the easier way to test.

> +# XXX: how much should we .save() the models?
>
> This is a fun issue too: if you're not careful you can create objects that violate database constraints because they are never flushed to the database. OTOH, you don't want to hit the database because that slows the tests down. I don't think there's a happy answer here, although maybe it's less of an issue in vostok compared Launchpad because we're using an automatically generated schema with less exotic constraints.

Yes, plus we can currently test with an in-memory sqlite. Doing .save()
is cheap it appears, as a commit is never done. As noted earlier though,
it doesn't look like django uses database constraints for many things,
such as max length.

I'm happy to have the factory save and rewrite the tests that check for
IntegrityErrors to skip the factory.

We could even make it configurable on the factory so that we can
experiment easily later with turning it off.

> The code looks inoffensive enough, it just prompts some more questions :-)

Yep, pretty much what I was looking for from the review :-)

Thanks,

James

[lp:~james-w/vostok/add-sourcepackagerelease-model]

28. By James Westby on 2010-06-04

Merge add-series-model in to add-sourcepackagerelease-model.

29. By James Westby on 2010-06-04

Merged add-series-model into add-sourcepackagerelease-model.

30. By James Westby on 2010-06-04

Have the factory save SourcePackageReleases as they are created.

31. By James Westby on 2010-06-04

Add __unicode__ to SourcePackageRelease.

Unmerged revisions

31. By James Westby on 2010-06-04

Add __unicode__ to SourcePackageRelease.

30. By James Westby on 2010-06-04

Have the factory save SourcePackageReleases as they are created.

29. By James Westby on 2010-06-04

Merged add-series-model into add-sourcepackagerelease-model.

28. By James Westby on 2010-06-04

Merge add-series-model in to add-sourcepackagerelease-model.

27. By James Westby on 2010-06-03

Add date_uploaded.

26. By James Westby on 2010-06-03

Add version to SourcePackageRelease.

25. By James Westby on 2010-06-03

Add source_name to SourcePackageRelease.

24. By James Westby on 2010-06-03

Merged add-series-model into add-sourcepackagerelease-model.

23. By James Westby on 2010-06-03

Add SourcePackageRelease skeleton.

22. By James Westby on 2010-06-03

Add status to Series.

=== modified file 'vostok/archives/factory.py'
--- vostok/archives/factory.py	2010-06-04 23:01:22 +0000
+++ vostok/archives/factory.py	2010-06-04 23:01:22 +0000
@@ -1,6 +1,8 @@
 """Factory for creating model objects with defaults."""
 
 
+import datetime
+
 from vostok.archives import models
 
 
@@ -43,3 +45,15 @@
         return models.Series.objects.create(
             distribution=distribution, short_name=short_name,
             display_name=display_name, status=status)
+
+    def make_sourcepackagerelease(self, source_name=None, version=None,
+            date_uploaded=None):
+        if source_name is None:
+            source_name = self.make_unique_string("sourcepackage")
+        if version is None:
+            version = "1"
+        if date_uploaded is None:
+            date_uploaded = datetime.datetime.utcnow()
+        return models.SourcePackageRelease.objects.create(
+            source_name=source_name, version=version,
+            date_uploaded=date_uploaded)

=== modified file 'vostok/archives/models.py'
--- vostok/archives/models.py	2010-06-04 23:01:22 +0000
+++ vostok/archives/models.py	2010-06-04 23:01:22 +0000
@@ -52,3 +52,28 @@
 
     def __unicode__(self):
         return u"%s %s" % (self.distribution, self.short_name)
+
+
+class SourcePackageRelease(models.Model):
+    """A particular version of a source package as seen by the software.
+
+    These are not unique wrt name and version, nor do they correspond to
+    a particular series, and they may not even be published.
+
+    They are instead the model containing the files for a particular upload
+    which we can then link to other models as needed, and finally publish
+    somewhere (possibly multiple places) if needed.
+
+    :ivar source_name: the name of the source package.
+    :ivar version: the version of the source package.
+    """
+
+    # TODO: does SlugField match package name requirements?
+    source_name = models.SlugField(blank=False)
+    # TODO: make version match required characters in a version number
+    version = models.CharField(max_length=50, blank=False)
+    date_uploaded = models.DateTimeField()
+    # TODO: uploader, signer
+
+    def __unicode__(self):
+        return u"%s %s" % (self.source_name, self.version)

=== modified file 'vostok/archives/tests.py'
--- vostok/archives/tests.py	2010-06-04 23:01:22 +0000
+++ vostok/archives/tests.py	2010-06-04 23:01:22 +0000
@@ -2,6 +2,9 @@
 Tests for the models.
 """
 
+
+import datetime
+
 from django.db import IntegrityError
 
 from vostok.archives import models
@@ -32,6 +35,9 @@
         self.assertNotEqual(string2, string3)
 
 
+# XXX: how much should we .save() the models?
+
+
 class TestDistribution(TestCaseWithFactory):
     """Tests for models.Distribution."""
 
@@ -107,3 +113,31 @@
     def test_has_status(self):
         series = self.factory.make_series(status='Active')
         self.assertEqual('Active', series.status)
+
+
+class TestSourcePackageRelease(TestCaseWithFactory):
+    """Tests for models.SourcePackageRelease."""
+
+    def test_create(self):
+        sourcepackagerelease = models.SourcePackageRelease()
+
+    def test_has_source_package_name(self):
+        sourcepackagerelease = self.factory.make_sourcepackagerelease(
+            source_name="bzr")
+        self.assertEquals("bzr", sourcepackagerelease.source_name)
+
+    def test_has_version(self):
+        sourcepackagerelease = self.factory.make_sourcepackagerelease(
+            version="2.1-1")
+        self.assertEquals("2.1-1", sourcepackagerelease.version)
+
+    def test_unicode(self):
+        sourcepackagerelease = self.factory.make_sourcepackagerelease(
+            source_name="bzr", version="2.1-1")
+        self.assertEquals(u"bzr 2.1-1", unicode(sourcepackagerelease))
+
+    def test_has_date_uploaded(self):
+        now = datetime.datetime.utcnow()
+        sourcepackagerelease = self.factory.make_sourcepackagerelease(
+            date_uploaded=now)
+        self.assertEquals(now, sourcepackagerelease.date_uploaded)