support not creating a base package

This is implemented by making PROVIDES optional and making the recipe not
declare anything to provide. PROVIDES de facto defines (sub)packages, so
leaving it out should be natural for a package that isn't actually created.

A build package (with fake PROVIDES) is still created to have a writable
$prefix.

A policy check is added that the main packaging directory is empty after
INSTALL() and that the recipe still at least declares one actual package.

Fixes #192.

Author: jmairboeck

HaikuPorter/BuildMaster.py

@@ -50,7 +50,8 @@ def __init__(self, port, portsTreePath, missingPackageIDs,
 		self.recipeFilePath \
 			= os.path.relpath(port.recipeFilePath, portsTreePath)
 		self.resultingPackages \
-			= [package.hpkgName for package in self.port.packages]
+			= [package.hpkgName for package in self.port.packages
+				if not package.isFakeEmptyPackage()]
 		self.packageRepository = packageRepository
 		self.requiredPackages = presentDependencyPackages
 		self.requiredPackageIDs = [
@@ -100,7 +101,8 @@ def __init__(self, portsTreePath, port, reason):
 			self.recipeFilePath \
 				= os.path.relpath(port.recipeFilePath, portsTreePath)
 			self.resultingPackages \
-				= [package.hpkgName for package in port.packages]
+				= [package.hpkgName for package in port.packages
+					if not package.isFakeEmptyPackage()]
 		else:
 			self.port = None
 			self.name = port
@@ -325,7 +327,8 @@ def runBuilds(self):
 		# Move anything to the lost state that depends on skipped builds.
 		for skippedBuild in self.skippedBuilds:
 			if skippedBuild.port:
-				self._packagesCompleted(skippedBuild.port.packages, False)
+				self._packagesCompleted([package for package in skippedBuild.port.packages
+						if not package.isFakeEmptyPackage()], False)
 
 		try:
 			self._ensureConsistentSchedule()
@@ -451,7 +454,8 @@ def _packagesCompleted(self, packages, available):
 						else:
 							# the build was lost, propagate lost packages
 							self.lostBuilds.append(blockedBuild)
-							completePackages += blockedBuild.port.packages
+							completePackages += [package for package in blockedBuild.port.packages
+								if not package.isFakeEmptyPackage()]
 					else:
 						stillBlockedBuilds.append(blockedBuild)
 
@@ -466,7 +470,8 @@ def _buildComplete(self, scheduledBuild, buildSuccess, listToUse):
 				self.activeBuilds.remove(scheduledBuild)
 			listToUse.append(scheduledBuild)
 
-		self._packagesCompleted(scheduledBuild.port.packages, buildSuccess)
+		self._packagesCompleted([package for package in scheduledBuild.port.packages
+				if not package.isFakeEmptyPackage()], buildSuccess)
 
 	def _buildThread(self, builder, scheduledBuild, buildNumber):
 		self.logger.info('starting build ' + str(buildNumber) + ', '

HaikuPorter/Package.py

@@ -207,10 +207,17 @@ def adjustToChroot(self):
 	def populatePackagingDir(self, port):
 		"""Prefill packaging directory with stuff from the outside"""
 
+		if self.isFakeEmptyPackage():
+			# don't add files to a fake package
+			return
+
 		licenseDir = port.baseDir + '/licenses'
 		if os.path.exists(licenseDir):
 			shutil.copytree(licenseDir, self.packagingDir + '/data/licenses')
 
+	def isFakeEmptyPackage(self):
+		return 'PROVIDES' not in self.recipeKeys or len(self.recipeKeys['PROVIDES']) == 0
+
 	def makeHpkg(self, requiresUpdater):
 		"""Create a package suitable for distribution"""
 
@@ -221,6 +228,10 @@ def makeHpkg(self, requiresUpdater):
 		# policy check, add some requires
 		self.policy.checkPackage(self, packageFile)
 
+		if self.isFakeEmptyPackage():
+			# don't actually create the package
+			return
+
 		if (requiresUpdater and self.type != PackageType.SOURCE):
 			requiresList = self.recipeKeys['REQUIRES']
 			self.recipeKeys['UPDATED_REQUIRES'] \
@@ -270,7 +281,7 @@ def createBuildPackage(self):
 		buildPackageInfo = (self.buildPackageDir + '/' + self.revisionedName
 							+ '-build.PackageInfo')
 		self._generatePackageInfo(buildPackageInfo,
-			['REQUIRES', 'BUILD_REQUIRES', 'BUILD_PREREQUIRES'], True, False,
+			['REQUIRES', 'BUILD_REQUIRES', 'BUILD_PREREQUIRES'], True, self.isFakeEmptyPackage(),
 			False, self.architecture)
 
 		# create the build package
@@ -322,10 +333,7 @@ def _generatePackageInfo(self, packageInfoPath, requiresToUse, quiet,
 			os.remove(packageInfoPath)
 
 		with codecs.open(packageInfoPath, 'w', 'utf-8') as infoFile:
-			if fakeEmptyProvides:
-				infoFile.write('name\t\t\tfaked_' + self.name + '\n')
-			else:
-				infoFile.write('name\t\t\t' + self.name + '\n')
+			infoFile.write('name\t\t\t' + self.name + '\n')
 			infoFile.write('version\t\t\t' + self.fullVersion + '\n')
 			infoFile.write('architecture\t\t' + architecture + '\n')
 			infoFile.write('summary\t\t\t"'
@@ -375,7 +383,7 @@ def _generatePackageInfo(self, packageInfoPath, requiresToUse, quiet,
 						requires.append(require)
 
 			if fakeEmptyProvides:
-				infoFile.write('provides {\n\tfaked_' + self.name + ' = '
+				infoFile.write('provides {\n\t' + self.name + ' = '
 							   + self.version + '\n}\n')
 			else:
 				self._writePackageInfoListByKey(infoFile, 'PROVIDES',

HaikuPorter/Policy.py

@@ -76,8 +76,11 @@ def checkPackage(self, package, packageFile):
 		self.provides = self._parseResolvableExpressionListForKey('PROVIDES')
 		self.requires = self._parseResolvableExpressionListForKey('REQUIRES')
 
+		if package.isFakeEmptyPackage():
+			self._checkFakePackageIsEmpty()
 		self._checkTopLevelEntries()
-		self._checkProvides()
+		if not package.isFakeEmptyPackage():
+			self._checkProvides()
 		self._checkLibraryDependencies()
 		self._checkMisplacedDevelopLibraries()
 		self._checkGlobalWritableFiles()
@@ -88,6 +91,10 @@ def checkPackage(self, package, packageFile):
 		if self.strict and self.violationEncountered:
 			sysExit("packaging policy violation(s) in strict mode")
 
+	def _checkFakePackageIsEmpty(self):
+		if len(os.listdir(self.package.packagingDir)) > 0:
+			self._violation("package without PROVIDES isn't empty")
+
 	def _checkTopLevelEntries(self):
 		for entry in os.listdir(self.package.packagingDir):
 			if entry not in allowedTopLevelEntries:

HaikuPorter/Port.py

@@ -283,6 +283,10 @@ def validateRecipeFile(self, showWarnings=False):
 			entries = recipeConfig.getEntriesForExtension(extension)
 			recipeKeys = {}
 
+			# make PROVIDES required for subpackages
+			if extension:
+				recipeAttributes['PROVIDES']['required'] = True
+
 			# check whether all required values are present
 			for baseKey in recipeAttributes.keys():
 				if extension:
@@ -516,8 +520,9 @@ def removeDependencyInfosFromRepository(self):
 	@property
 	def mainPackage(self):
 		self.parseRecipeFileIfNeeded()
-		if self.packages:
-			return self.packages[0]
+		for package in self.packages:
+			if not package.isFakeEmptyPackage():
+				return package
 		return None
 
 	@property
@@ -1037,6 +1042,10 @@ def _parseRecipeFile(self, showWarnings, forceAllowUnstable=False):
 				forceAllowUnstable):
 				self.packages.append(package)
 
+		# check that we have any actual package
+		if not any(not package.isFakeEmptyPackage() for package in self.allPackages):
+			sysExit("recipe '%s' doesn't define any package" % self.recipeFilePath)
+
 		if not self.isMetaPort:
 			# create source package if it hasn't been specified or disabled:
 			if (not haveSourcePackage and not keys['DISABLE_SOURCE_PACKAGE']

HaikuPorter/RecipeAttributes.py

@@ -221,8 +221,8 @@ def getRecipeFormatVersion():
 	},
 	'PROVIDES': {
 		'type': ProvidesList,
-		'required': True,
-		'default': None,
+		'required': False,
+		'default': [],
 		'extendable': Extendable.DEFAULT,
 		'indexable': False,
 	},