bitbake: toaster: show installed package name

[YOCTO #5922]

Implement changes that show the installed package name after the
official 'recipe-named' package name.  If the alias exists and
is different than the package name, then the alias is shown as a
'muted' string after the package name in the form 'as some-alias-name'.
This formatting appears in the included package pages in the elements:
* local breadcrumbs at the top of package included pages,
* <h1> title headings along with a help bubble that is not hovering,
and
* package lists where the help bubble appears when the mouse hovers
over the row.

The changes in detail in this patch per file are:
views.py
- added function that tests whether the package object's installed_name
should be shown,
- added function that appends package name with version and revision to
encapsulate package name formatting in one place and referred to as
package.fullpackagespec,
- changed package_built* and package_included* functions to use both
of the above new formatting functions, passing the formatted values to
templates, and
- adhered to django coding styles by renaming  module local
'get_package*' functions with "_" prefix.

package_detail_base.html
- added display of package aliases for included package page,
- refactored to use package.fullpackagespec, formatted by view function,
- added javascript function to format package alias with help, and
- removed trailing whitespace.

package_included_detail.html
- used javascript function above to format package alias, and
- refactored to use package.fullpackagespec.

package_included_dependencies.html
- used javascript function above to format package alias,
- refactored to use package.fullpackagespec,
- forced empty data cells following hover-help to draw borders
by appending space, and
- removed trailing whitespace.

package_included_reverse_dependencies.html
- use javascript function above to format package alias,
- refactor to use views fullpackagespe, and
- force empty data cells following hover-help to draw borders
by appending space.

package_built_detail.html
- refactored to use package.fullpackagespec, and
- removed trailing whitespace.

package_built_dependencies.html
- refactored to use package.fullpackagespec, and
- removed trailing whitespace.

projecttags.py
- removed unused filter to handle installed name
- removed extra spaces around "title = " in format_vpackage_namehelp

(Bitbake rev: c604e14df8cdb1f47535f093d7044955d4c2057d)

Signed-off-by: Dave Lerner <dave.lerner@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

bitbake/lib/toaster/toastergui/templates/package_built_dependencies.html

@@ -2,7 +2,6 @@
 {% load projecttags %}
 
 {% block tabcontent %}
-    {% with fullPackageSpec=package.name|add:"-"|add:package.version|add:"-"|add:package.revision|filtered_packagespec %}
         <ul class="nav nav-pills">
             <li class="">
                 <a href="{% url 'package_built_detail' build.id package.id %}">
@@ -21,11 +20,11 @@
             <div class="tab-pane active" id="dependencies">
             {% ifequal runtime_deps|length 0 %}
                 <div class="alert alert-info">
-                    <strong>{{fullPackageSpec}}</strong> has no runtime dependencies.
+                    <strong>{{package.fullpackagespec}}</strong> has no runtime dependencies.
                 </div>
             {% else %}
                 <div class="alert alert-info">
-                    <strong>{{fullPackageSpec}}</strong> is <strong>not included</strong> in any image.  These are its projected runtime dependencies if you were to include it in future builds.
+                    <strong>{{package.fullpackagespec}}</strong> is <strong>not included</strong> in any image.  These are its projected runtime dependencies if you were to include it in future builds.
                 </div>
                 <table class="table table-bordered table-hover">
                     <thead>
@@ -106,5 +105,4 @@
                 {% endifnotequal %}
             </div> <!-- tab-pane -->
         </div> <!-- tab-content -->
-    {% endwith %}
 {% endblock tabcontent %}

bitbake/lib/toaster/toastergui/templates/package_built_detail.html

@@ -2,7 +2,7 @@
 {% load projecttags %}
 
 {% block tabcontent %}
-    {% with fullPackageSpec=package.name|add:"-"|add:package.version|add:"-"|add:package.revision|filtered_packagespec packageFileCount=package.buildfilelist_package.count %}
+    {% with packageFileCount=package.buildfilelist_package.count %}
         <!-- Generated Files -->
         {% if package.buildtargetlist_package.count == 0 %}
             {# Not included case #}
@@ -21,7 +21,7 @@
             <!-- Package file list or if empty, alert pane -->
             {% if packageFileCount > 0 %}
                 <div class="alert alert-info">
-                    {{fullPackageSpec}} is <strong>not included</strong> in any image.  These are the files that would be added to an image root file system if you were to include it in future builds.
+                    {{package.fullpackagespec}} is <strong>not included</strong> in any image.  These are the files that would be added to an image root file system if you were to include it in future builds.
                 </div>
                 <table class="table table-bordered table-hover">
                     <thead>
@@ -42,7 +42,7 @@
 
             {% else %}
                 <div class="alert alert-info">
-                    <strong>{{fullPackageSpec}}</strong> does not generate any files.
+                    <strong>{{package.fullpackagespec}}</strong> does not generate any files.
                 </div>
             {% endif %}
 

bitbake/lib/toaster/toastergui/templates/package_detail_base.html

@@ -1,24 +1,45 @@
 {% extends "basebuilddetailpage.html" %}
 {% load projecttags %}
 
+{% block extraheadcontent %}
+    <!-- functions to format package 'installed_package' alias -->
+    <script>
+    function fmtAliasHelp(package_name, alias, hover) {
+        var r = null;
+        if (alias != null && alias != '') {
+            r = '<span class="muted"> as ' + alias + '&nbsp';
+            r += '<i class="icon-question-sign get-help';
+            if (hover) {
+                r+= ' hover-help';
+            }
+            else {
+                r+= ' heading-help';
+            }
+            r += '"';
+            title = package_name + ' was renamed at packaging time and was installed on your system as ' + alias;
+            r += ' title="' + title + '">';
+            r += '</i>';
+            r += '</span>';
+            document.write(r);
+        }
+    }
+    </script>
+{% endblock extraheadcontent %}
 {% block localbreadcrumb %}
-{% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec %}
     {% if target %}
         <li><a href="{% url "target" build.id target.id %}">{{target.target}}</a></li>
+        <li>{{package.fullpackagespec}} {% if package.alias %} as {{package.alias}}{% endif %}</li>
     {% else %}
         <li><a href="{% url "packages" build.id %}"> Packages </a></li>
+        <li>{{package.fullpackagespec}}</li>
     {% endif %}
-        <li>{{fullPackageSpec}}</li>
-{% endwith %}
 {% endblock localbreadcrumb %}
 
 {% block pagedetailinfomain %}
-{% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec %}
-
     <div class="row span11">
         <div class="page-header">
             {% block title %}
-            <h1>{{fullPackageSpec}}</h1>
+            <h1>{{package.fullpackagespec}}</h1>
             {% endblock title %}
         </div> <!-- page-header -->
     </div> <!-- row span11 page-header -->
@@ -121,5 +142,4 @@
         </dl>
     </div> <!-- row4 well -->
     {% endblock twocolumns %}
-{% endwith %}
 {% endblock pagedetailinfomain %}

bitbake/lib/toaster/toastergui/templates/package_included_dependencies.html

@@ -2,13 +2,15 @@
 {% load projecttags %}
 
 {% block title %}
-    {% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec %}
+    <h1>
-        <h1>{{fullPackageSpec}} <small>({{target.target}})</small></h1>
+        {{package.fullpackagespec}}
-    {% endwith %}
+        <script> fmtAliasHelp("{{package.name}}", "{{package.alias}}", false) </script>
+        <small>({{target.target}})</small>
+    </h1>
 {% endblock title %}
 
 {% block tabcontent %}
-    {% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec packageFileCount=package.buildfilelist_package.count %}
+    {% with packageFileCount=package.buildfilelist_package.count %}
     {% include "package_included_tabs.html" with active_tab="dependencies" %}
     <div class="tab-content">
        <div class="tab-pane active" id="dependencies">
@@ -29,22 +31,22 @@
                                <a href="{% url 'package_included_detail' build.id target.id runtime_dep.depends_on_id %}">
                                     {{runtime_dep.name}}
                                 </a>
+                                <script>fmtAliasHelp("{{runtime_dep.name}}", "{{runtime_dep.alias}}", true)</script>
                             </td>
                             {% else %}
                             <td>
                                 {{runtime_dep.name|format_vpackage_namehelp}}
                             </td>
                             {% endif %}
-
+                            <td>{{runtime_dep.version}}&nbsp;</td>
-                            <td>{{runtime_dep.version}}</td>
+                            <td>{{runtime_dep.size|filtered_filesizeformat}}&nbsp;</td>
-                            <td>{{runtime_dep.size|filtered_filesizeformat}}</td>
                         </tr>
 					{% endfor %}
                  </tbody>
             </table>
         {% else %}
             <div class="alert alert-info">
-                <strong>{{fullPackageSpec}}</strong> has no runtime dependencies.
+                <strong>{{package.fullpackagespec}}</strong> has no runtime dependencies.
             </div>
         {% endifnotequal %}
 
@@ -70,6 +72,9 @@
                                 <td>
                                     <a href="{% url 'package_included_detail' build.id target.id other_dep.depends_on_id %}">
                                         {{other_dep.name}}
+                                        <script>
+                                        fmtAliasHelp("{{other_dep.name}}","{{other_dep.alias}}", true)
+                                        </script>
                                     </a>
                                 </td>
                                 {% else %}
@@ -77,8 +82,8 @@
                                         {{other_dep.name|format_vpackage_namehelp}}
                                     </td>
                                 {% endif %}
-                                <td>{{other_dep.version}}</td>
+                                <td>{{other_dep.version}}&nbsp;</td>
-                                <td>{{other_dep.size|filtered_filesizeformat}}</td>
+                                <td>{{other_dep.size|filtered_filesizeformat}}&nbsp;</td>
                                 <td>
                                     {{other_dep.dep_type_display}}
                                     <i class="icon-question-sign get-help hover-help" title="{{other_dep.dep_type_help}}" ></i>

bitbake/lib/toaster/toastergui/templates/package_included_detail.html

@@ -2,13 +2,17 @@
 {% load projecttags %}
 
 {% block title %}
-{% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec %}
+        <h1>
-        <h1>{{fullPackageSpec}} <small>({{target.target}})</small></h1>
+            {{package.fullpackagespec}}
-{% endwith %}
+            <script>
+                fmtAliasHelp("{{package.name}}", "{{package.alias}}", false)
+            </script>
+            <small>({{target.target}})</small>
+        </h1>
 {% endblock title %}
 
 {% block tabcontent %}
-{% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec packageFileCount=package.buildfilelist_package.count %}
+{% with packageFileCount=package.buildfilelist_package.count %}
     {% include "package_included_tabs.html" with active_tab="detail" %}
     <div class="tab-content">
         <div class="tab-pane active" id="files">
@@ -36,7 +40,7 @@
 
             {% else %}
             <div class="alert alert-info">
-                <strong>{{fullPackageSpec}}</strong> does not generate any files.
+                <strong>{{package.fullpackagespec}}</strong> does not generate any files.
             </div>
             {% endif %}
         </div> <!-- end tab-pane -->

bitbake/lib/toaster/toastergui/templates/package_included_reverse_dependencies.html

@@ -2,20 +2,22 @@
 {% load projecttags %}
 
 {% block title %}
-    {% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec  %}
+        <h1>
-        <h1>{{fullPackageSpec}} <small>({{target.target}})</small></h1>
+            {{package.fullpackagespec}}
-    {% endwith %}
+            <script> fmtAliasHelp("{{package.name}}", "{{package.alias}}", false) </script>
+            <small>({{target.target}})</small>
+        </h1>
 {% endblock title %}
 
 {% block tabcontent %}
-    {% with fullPackageSpec=package.name|add:"_"|add:package.version|add:"-"|add:package.revision|filtered_packagespec packageFileCount=package.buildfilelist_package.count %}
+    {% with packageFileCount=package.buildfilelist_package.count %}
     {% include "package_included_tabs.html" with active_tab="reverse" %}
     <div class="tab-content">
         <div class="tab-pane active" id="brought-in-by">
 
         {% ifequal reverse_deps|length  0 %}
            <div class="alert alert-info">
-                <strong>{{fullPackageSpec}}</strong> has no reverse runtime dependencies.
+                <strong>{{package.fullpackagespec}}</strong> has no reverse runtime dependencies.
             </div>
         {% else %}
             <table class="table table-bordered table-hover">
@@ -34,6 +36,7 @@
                                 <a href="{% url 'package_included_detail' build.id target.id reverse_dep.dependent_id %}">
                                     {{reverse_dep.name}}
                                 </a>
+                                <script>fmtAliasHelp("{{reverse_dep.name}}", "{{reverse_dep.alias}}", true)</script>
                             </td>
                             {% else %}
                             <td>
@@ -41,8 +44,8 @@
                             </td>
                             {% endif %}
 
-                            <td>{{reverse_dep.version}}</td>
+                            <td>{{reverse_dep.version}}&nbsp;</td>
-                            <td>{{reverse_dep.size|filtered_filesizeformat}}</td>
+                            <td>{{reverse_dep.size|filtered_filesizeformat}}&nbsp;</td>
                         </tr>
 					{% endfor %}
                 </tbody>

bitbake/lib/toaster/toastergui/templatetags/projecttags.py

@@ -207,14 +207,6 @@ def filtered_installedsize(size, installed_size):
     """
     return size if (installed_size == 0) or (installed_size == "") or (installed_size == None) else installed_size
 
-@register.filter
-def filtered_installedname(name, installed_name):
-    """If package.installed_name not null and not empty
-        return <div class=muted> as {{package.installed_name}}
-        otherwise ""
-    """
-    return name if (name == installed_name) or (not installed_name) or (installed_name == "") else name + " as " + installed_name
-
 @register.filter
 def filtered_packageversion(version, revision):
     """ Emit "version-revision" if version and revision are not null
@@ -245,6 +237,6 @@ def format_vpackage_rowclass(size):
 def format_vpackage_namehelp(name):
     r =  name + '&nbsp;'
     r += '<i class="icon-question-sign get-help hover-help"'
-    r += ' title = "' + name + ' only has dependency information available.">'
+    r += ' title="' + name + ' only has dependency information available.">'
     r += '</i>'
     return mark_safe(r)

bitbake/lib/toaster/toastergui/views.py

@@ -1280,7 +1280,7 @@ the RRECOMENDS or TRECOMENDS value.
 The lists are built in the sort order specified for the package runtime
 dependency views.
 """
-def get_package_dependencies(package_id, target_id = INVALID_KEY):
+def _get_package_dependencies(package_id, target_id = INVALID_KEY):
     runtime_deps = []
     other_deps = []
     other_depends_types = OTHER_DEPENDS_BASE
@@ -1318,6 +1318,10 @@ def get_package_dependencies(package_id, target_id = INVALID_KEY):
                 'depends_on_id' : dep_package.id,
                 'installed' : installed,
                 }
+
+        if target_id != INVALID_KEY:
+                dep['alias'] = _get_package_alias(dep_package)
+
         if idep.dep_type == rdepends_type :
             runtime_deps.append(dep)
         elif idep.dep_type in other_depends_types :
@@ -1331,28 +1335,50 @@ def get_package_dependencies(package_id, target_id = INVALID_KEY):
     return retvalues
 
 # Return the count of packages dependent on package for this target_id image
-def get_package_reverse_dep_count(package, target_id):
+def _get_package_reverse_dep_count(package, target_id):
     return package.package_dependencies_target.filter(target_id__exact=target_id, dep_type__exact = Package_Dependency.TYPE_TRDEPENDS).count()
 
 # Return the count of the packages that this package_id is dependent on.
 # Use one of the two RDEPENDS types, either TRDEPENDS if the package was
 # installed, or else RDEPENDS if only built.
-def get_package_dependency_count(package, target_id, is_installed):
+def _get_package_dependency_count(package, target_id, is_installed):
     if is_installed :
         return package.package_dependencies_source.filter(target_id__exact = target_id,
             dep_type__exact = Package_Dependency.TYPE_TRDEPENDS).count()
     else :
         return package.package_dependencies_source.filter(dep_type__exact = Package_Dependency.TYPE_RDEPENDS).count()
 
+def _get_package_alias(package):
+    alias = package.installed_name
+    if alias != None and alias != '' and alias != package.name:
+        return alias
+    else:
+        return ''
+
+def _get_fullpackagespec(package):
+    r = package.name
+    version_good = package.version != None and  package.version != ''
+    revision_good = package.revision != None and package.revision != ''
+    if version_good or revision_good:
+        r += '_'
+        if version_good:
+            r += package.version
+            if revision_good:
+                r += '-'
+        if revision_good:
+            r += package.revision
+    return r
+
 def package_built_detail(request, build_id, package_id):
     template = "package_built_detail.html"
     if Build.objects.filter(pk=build_id).count() == 0 :
         return redirect(builds)
     package = Package.objects.filter(pk=package_id)[0]
+    package.fullpackagespec = _get_fullpackagespec(package)
     context = {
             'build' : Build.objects.filter(pk=build_id)[0],
             'package' : package,
-            'dependency_count' : get_package_dependency_count(package, -1, False),
+            'dependency_count' : _get_package_dependency_count(package, -1, False),
     }
     return render(request, template, context)
 
@@ -1362,13 +1388,14 @@ def package_built_dependencies(request, build_id, package_id):
          return redirect(builds)
 
     package = Package.objects.filter(pk=package_id)[0]
-    dependencies = get_package_dependencies(package_id)
+    package.fullpackagespec = _get_fullpackagespec(package)
+    dependencies = _get_package_dependencies(package_id)
     context = {
             'build' : Build.objects.filter(pk=build_id)[0],
             'package' : package,
             'runtime_deps' : dependencies['runtime_deps'],
             'other_deps' :   dependencies['other_deps'],
-            'dependency_count' : get_package_dependency_count(package, -1,  False)
+            'dependency_count' : _get_package_dependency_count(package, -1,  False)
     }
     return render(request, template, context)
 
@@ -1379,13 +1406,15 @@ def package_included_detail(request, build_id, target_id, package_id):
         return redirect(builds)
 
     package = Package.objects.filter(pk=package_id)[0]
+    package.fullpackagespec = _get_fullpackagespec(package)
+    package.alias = _get_package_alias(package)
     target = Target.objects.filter(pk=target_id)[0]
     context = {
             'build' : Build.objects.filter(pk=build_id)[0],
             'target'  : target,
             'package' : package,
-            'reverse_count' : get_package_reverse_dep_count(package, target_id),
+            'reverse_count' : _get_package_reverse_dep_count(package, target_id),
-            'dependency_count' : get_package_dependency_count(package, target_id, True)
+            'dependency_count' : _get_package_dependency_count(package, target_id, True)
     }
     return render(request, template, context)
 
@@ -1395,17 +1424,19 @@ def package_included_dependencies(request, build_id, target_id, package_id):
         return redirect(builds)
 
     package = Package.objects.filter(pk=package_id)[0]
+    package.fullpackagespec = _get_fullpackagespec(package)
+    package.alias = _get_package_alias(package)
     target = Target.objects.filter(pk=target_id)[0]
 
-    dependencies = get_package_dependencies(package_id, target_id)
+    dependencies = _get_package_dependencies(package_id, target_id)
     context = {
             'build' : Build.objects.filter(pk=build_id)[0],
             'package' : package,
             'target' : target,
             'runtime_deps' : dependencies['runtime_deps'],
             'other_deps' :   dependencies['other_deps'],
-            'reverse_count' : get_package_reverse_dep_count(package, target_id),
+            'reverse_count' : _get_package_reverse_dep_count(package, target_id),
-            'dependency_count' : get_package_dependency_count(package, target_id, True)
+            'dependency_count' : _get_package_dependency_count(package, target_id, True)
     }
     return render(request, template, context)
 
@@ -1415,6 +1446,8 @@ def package_included_reverse_dependencies(request, build_id, target_id, package_
         return redirect(builds)
 
     package = Package.objects.filter(pk=package_id)[0]
+    package.fullpackagespec = _get_fullpackagespec(package)
+    package.alias = _get_package_alias(package)
     target = Target.objects.filter(pk=target_id)[0]
 
     reverse_deps = []
@@ -1426,6 +1459,7 @@ def package_included_reverse_dependencies(request, build_id, target_id, package_
             version += '-' + dep_package.revision
         dep = {
                 'name' : dep_package.name,
+                'alias' :  _get_package_alias(dep_package),
                 'dependent_id' : dep_package.id,
                 'version' : version,
                 'size' : dep_package.size
@@ -1438,8 +1472,8 @@ def package_included_reverse_dependencies(request, build_id, target_id, package_
             'package' : package,
             'target' : target,
             'reverse_deps' : reverse_deps,
-            'reverse_count' : get_package_reverse_dep_count(package, target_id),
+            'reverse_count' : _get_package_reverse_dep_count(package, target_id),
-            'dependency_count' : get_package_dependency_count(package, target_id, True)
+            'dependency_count' : _get_package_dependency_count(package, target_id, True)
     }
     return render(request, template, context)