diff --git a/bin/toaster b/bin/toaster index 16a64bab6..79b3cdbda 100755 --- a/bin/toaster +++ b/bin/toaster @@ -263,7 +263,7 @@ fi # 4) pid's we need to clean up on exit/shutdown # By default we move this all into the Toaster's parent build directory export TOASTER_DIR=$BUILDDIR -export BB_ENV_PASSTHROUGH_ADDITIONS="$BB_ENV_PASSTHROUGH_ADDITIONS TOASTER_DIR" +export BB_ENV_PASSTHROUGH_ADDITIONS="$BB_ENV_PASSTHROUGH_ADDITIONS TOASTER_DIR TOASTER_PROJECT" # Determine the action. If specified by arguments, fine, if not, toggle it if [ "$CMD" = "start" ] ; then diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index fd75275bb..41e8ec74d 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -1922,6 +1922,19 @@ overview of their function and contents. consist mostly of task logs and scripts, when building a particular recipe. + :term:`TOASTER_PROJECT` + Specifies the name of the Toaster project in which to store a build + started from the command line. If the project does not exist, Toaster + creates it. If this variable is not set, Toaster stores the build in the + default "Command line builds" project. This variable has no effect on + builds started from the Toaster web interface. + + Toaster reads this variable from the BitBake datastore, so it is also + recorded in event logs. You can set it in a configuration file such as + ``local.conf``. To set it from the environment, the variable must be + listed in :term:`BB_ENV_PASSTHROUGH_ADDITIONS`, which the ``toaster`` + start script does for you. + :term:`TOPDIR` Points to the build directory. BitBake automatically sets this variable. diff --git a/lib/bb/ui/buildinfohelper.py b/lib/bb/ui/buildinfohelper.py index 4ee45d67a..787cab952 100644 --- a/lib/bb/ui/buildinfohelper.py +++ b/lib/bb/ui/buildinfohelper.py @@ -143,7 +143,12 @@ class ORMWrapper(object): # pylint: disable=bad-continuation # we do not follow the python conventions for continuation indentation due to long lines here - def get_or_create_build_object(self, brbe): + def get_or_create_build_object(self, brbe, project_name=None): + """ + project_name: for command line builds, the project to put the build + into (created if needed); None or empty for the default project + """ + project_name = project_name.strip() if project_name else None prj = None buildrequest = None if brbe is not None: @@ -152,6 +157,12 @@ class ORMWrapper(object): br, _ = brbe.split(":") buildrequest = BuildRequest.objects.get(pk=br) prj = buildrequest.project + elif project_name: + # CLI build with TOASTER_PROJECT set + prj = Project.objects.filter(name=project_name).first() + if prj is None: + prj = Project.objects.create_project(project_name, None) + logger.debug("buildinfohelper: project is %s" % prj) else: # CLI build prj = Project.objects.get_or_create_default_project() @@ -348,8 +359,7 @@ class ORMWrapper(object): # and therefore we return the 'real' recipe rather than the build # history copy of the recipe. if recipe_information['layer_version'].build is not None and \ - recipe_information['layer_version'].build.project == \ - Project.objects.get_or_create_default_project(): + recipe_information['layer_version'].build.get_buildrequest() is None: return recipe if built_recipe is None: @@ -394,7 +404,7 @@ class ORMWrapper(object): # If we're doing a command line build then associate this new layer with the # project to avoid it 'contaminating' toaster data project = None - if build_obj.project == Project.objects.get_or_create_default_project(): + if build_obj.get_buildrequest() is None: project = build_obj.project layer_version_object, _ = Layer_Version.objects.get_or_create( @@ -924,9 +934,13 @@ class BuildInfoHelper(object): data on the bitbake server """ if not 'build' in self.internal_state or not self.internal_state['build']: - # create the Build object + # create the Build object; command line builds go into the + # project named by TOASTER_PROJECT, if set + project_name = None + if self.brbe is None: + project_name, _ = self.server.runCommand(["getVariable", "TOASTER_PROJECT"]) self.internal_state['build'] = \ - self.orm_wrapper.get_or_create_build_object(self.brbe) + self.orm_wrapper.get_or_create_build_object(self.brbe, project_name) build = self.internal_state['build'] diff --git a/lib/toaster/tests/browser/test_all_builds_page.py b/lib/toaster/tests/browser/test_all_builds_page.py index 9ab81fb11..baf65ebc3 100644 --- a/lib/toaster/tests/browser/test_all_builds_page.py +++ b/lib/toaster/tests/browser/test_all_builds_page.py @@ -192,6 +192,8 @@ class TestAllBuildsPage(SeleniumTestCase): but should be shown for other builds """ build1 = Build.objects.create(**self.project1_build_success) + BuildRequest.objects.create(project=self.project1, build=build1, + state=BuildRequest.REQ_COMPLETED) default_build = Build.objects.create( **self.default_project_build_success) diff --git a/lib/toaster/tests/buildinfohelper/__init__.py b/lib/toaster/tests/buildinfohelper/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/lib/toaster/tests/buildinfohelper/test_cli_project.py b/lib/toaster/tests/buildinfohelper/test_cli_project.py new file mode 100644 index 000000000..edc22e121 --- /dev/null +++ b/lib/toaster/tests/buildinfohelper/test_cli_project.py @@ -0,0 +1,131 @@ +#! /usr/bin/env python3 +# +# BitBake Toaster Implementation +# +# SPDX-License-Identifier: GPL-2.0-only +# + +"""Project of command line builds (TOASTER_PROJECT).""" + +from unittest import mock + +from django.template import Context, Template +from django.test import TestCase +from django.urls import reverse +from django.utils import timezone + +from bb.ui.buildinfohelper import BuildInfoHelper, ORMWrapper +from bldcontrol.models import BuildRequest +from orm.models import Build, Project, Layer, Layer_Version, ToasterSetting + + +class CommandLineBuildProjectTests(TestCase): + + def setUp(self): + self.orm = ORMWrapper() + + def test_default_project_without_name(self): + for name in (None, '', ' '): + build = self.orm.get_or_create_build_object(None, name) + self.assertTrue(build.project.is_default) + + def test_named_project_is_created_once(self): + ToasterSetting.objects.create(name='DEFCONF_MACHINE', value='qemux86-64') + first = self.orm.get_or_create_build_object(None, 'poky: master') + second = self.orm.get_or_create_build_object(None, 'poky: master') + self.assertEqual(first.project.name, 'poky: master') + self.assertFalse(first.project.is_default) + self.assertEqual(first.project, second.project) + self.assertEqual(first.project.get_variable('MACHINE'), 'qemux86-64') + self.assertEqual(Project.objects.filter(name='poky: master').count(), 1) + + def test_existing_project_is_used(self): + project = Project.objects.create(name='existing') + build = self.orm.get_or_create_build_object(None, 'existing') + self.assertEqual(build.project, project) + + def test_layers_stay_with_the_project(self): + # like for the default project, layers of a command line build are + # associated with its project and not added to the shared layer data + build = self.orm.get_or_create_build_object(None, 'poky: master') + layer_version = self.orm.get_update_layer_version_object( + build, Layer.objects.create(name='meta-test'), + {'branch': 'master', 'commit': 'abc', 'priority': 6, + 'local_path': '/srv/meta-test'}) + self.assertEqual(layer_version.project, build.project) + self.assertEqual(Layer_Version.objects.get(pk=layer_version.pk).build, build) + + +class FakeServer: + + values = { + 'TMPDIR': '/tmp', + 'TOASTER_PROJECT': 'poky: master', + 'BUILDNAME': 'test-build', + 'MACHINE': 'qemux86-64', + 'DISTRO': 'poky', + 'DISTRO_VERSION': 'test', + 'BB_VERSION': 'test', + } + + def runCommand(self, command): + return self.values.get(command[1]), None + + +class BuildInfoHelperProjectTests(TestCase): + + def test_toaster_project_is_read_from_bitbake(self): + helper = BuildInfoHelper(FakeServer()) + helper.store_started_build() + build = helper.internal_state['build'] + self.assertEqual(build.project.name, 'poky: master') + self.assertEqual(build.machine, 'qemux86-64') + + +class CommandLineBuildWidgetTests(TestCase): + + def test_only_managed_build_can_be_rebuilt(self): + project = Project.objects.create(name='poky: master') + now = timezone.now() + cli_build = Build.objects.create(project=project, started_on=now, + completed_on=now, + outcome=Build.SUCCEEDED) + managed_build = Build.objects.create(project=project, started_on=now, + completed_on=now, + outcome=Build.SUCCEEDED) + BuildRequest.objects.create(project=project, build=managed_build, + state=BuildRequest.REQ_COMPLETED) + + response = self.client.get(reverse('most_recent_builds')) + self.assertEqual(response.status_code, 200) + builds = {build['id']: build for build in response.json()} + self.assertTrue(builds[cli_build.id]['is_cli_build']) + self.assertFalse(builds[managed_build.id]['is_cli_build']) + + +@mock.patch('toastergui.views.project_enable', True) +@mock.patch.dict('os.environ', {'TOASTER_BUILDSERVER': '1'}) +class CommandLineProjectPagesTests(TestCase): + """In build mode, a project without a release only holds command line + builds and cannot be configured or built from Toaster""" + + def setUp(self): + self.project = ORMWrapper().get_or_create_build_object( + None, 'poky: master').project + self.builds_url = reverse('projectbuilds', args=(self.project.id,)) + + def test_configuration_pages_redirect_to_builds(self): + for name in ('project', 'projectconf'): + response = self.client.get(reverse(name, args=(self.project.id,))) + self.assertRedirects(response, self.builds_url, + fetch_redirect_response=False) + + def test_builds_page_has_no_project_topbar(self): + response = self.client.get(self.builds_url) + self.assertEqual(response.status_code, 200) + self.assertNotContains(response, 'id="project-topbar"') + + def test_project_url_is_builds_page(self): + template = Template('{% load project_url_tag %}{% project_url p %}') + self.assertEqual(template.render(Context({'p': self.project})), + self.builds_url) diff --git a/lib/toaster/tests/views/test_nobuild.py b/lib/toaster/tests/views/test_nobuild.py index a8ee82179..4bcb9853e 100644 --- a/lib/toaster/tests/views/test_nobuild.py +++ b/lib/toaster/tests/views/test_nobuild.py @@ -15,12 +15,18 @@ from django.urls import reverse from django.utils import timezone from orm.models import Project, Build, Variable, Layer, Layer_Version, Recipe +from orm.models import BitbakeVersion, Release class ProjectPagesBase(TestCase): def setUp(self): - self.project = Project.objects.create(name="test project") + bbv = BitbakeVersion.objects.create(name='bbv', giturl='/tmp/', + branch='master', dirpath='') + release = Release.objects.create(name='release', + bitbake_version=bbv) + self.project = Project.objects.create(name="test project", + release=release) self.builds_url = reverse('projectbuilds', args=(self.project.id,)) self.config_url = reverse('project', args=(self.project.id,)) diff --git a/lib/toaster/toastergui/templates/basebuildpage.html b/lib/toaster/toastergui/templates/basebuildpage.html index b7982dd2c..db3e3494a 100644 --- a/lib/toaster/toastergui/templates/basebuildpage.html +++ b/lib/toaster/toastergui/templates/basebuildpage.html @@ -148,8 +148,9 @@ - - {% if project_enable %} + + {% if project_enable and build.project.release %} {% with build.get_custom_image_recipes as custom_image_recipes %} {% if custom_image_recipes.count > 0 %} diff --git a/lib/toaster/toastergui/templates/mrb_section.html b/lib/toaster/toastergui/templates/mrb_section.html index 9fc7dfaee..91c3e6f5b 100644 --- a/lib/toaster/toastergui/templates/mrb_section.html +++ b/lib/toaster/toastergui/templates/mrb_section.html @@ -255,7 +255,7 @@