Add view to run experiments based on a given entity version

.gitignore

@@ -102,6 +102,9 @@ ENV/
 # Rope project settings
 .ropeproject
 
+# PyCharm files
+.idea/
+
 # mkdocs documentation
 /site
 
@@ -113,5 +116,3 @@ weblab/data/
 
 # media directory
 weblab/media/
-
-weblab/\.idea/

weblab/entities/templatetags/entities.py

@@ -189,3 +189,10 @@ def can_delete_entity(context, entity):
 def can_manage_entity(context, entity):
     user = context['user']
     return entity.is_managed_by(user)
+
+
+@register.filter
+def url_run_experiments(entity, commit):
+    last_tag = _url_friendly_label(entity, commit)
+    args = [entity.entity_type, entity.id, last_tag]
+    return reverse('entities:runexperiments', args=args)

weblab/entities/tests/test_templatetags.py

@@ -123,3 +123,16 @@ def test_url_friendly_label(model_with_version, helpers):
     commit3 = helpers.add_version(model_with_version)
     model_with_version.repo.tag('latest')
     assert entity_tags._url_friendly_label(model_with_version, commit3) == commit3.hexsha
+
+
+@pytest.mark.django_db
+def test_url_runexperiments(model_with_version, protocol_with_version):
+    model = model_with_version
+    model_commit = model.repo.latest_commit
+    assert (entity_tags.url_run_experiments(model, model_commit) ==
+            '/entities/models/%d/versions/%s/runexperiments' % (model.pk, model_commit.hexsha))
+
+    protocol = protocol_with_version
+    protocol_commit = protocol.repo.latest_commit
+    assert (entity_tags.url_run_experiments(protocol, protocol_commit) ==
+            '/entities/protocols/%d/versions/%s/runexperiments' % (protocol.pk, protocol_commit.hexsha))

weblab/entities/urls.py

@@ -118,6 +118,12 @@
         name='entity_archive',
     ),
 
+    url(
+        r'^%s/(?P<pk>\d+)/versions/%s/runexperiments$' % (_ENTITY_TYPE, _COMMIT),
+        views.EntityRunExperimentView.as_view(),
+        name='runexperiments',
+    ),
+
     url(
         r'^(?P<pk>\d+)/upload-file$',
         views.FileUploadView.as_view(),

weblab/entities/views.py

@@ -41,7 +41,7 @@
 from core.visibility import (
     Visibility, VisibilityMixin
 )
-from experiments.models import Experiment, PlannedExperiment
+from experiments.models import Experiment, PlannedExperiment, ExperimentVersion
 from repocache.exceptions import RepoCacheMiss
 from repocache.models import CachedEntityVersion
 
@@ -1016,3 +1016,80 @@ def get(self, request, *args, **kwargs):
         return JsonResponse({
             task: result
         })
+
+
+class EntityRunExperimentView(PermissionRequiredMixin, LoginRequiredMixin,
+                              EntityTypeMixin, EntityVersionMixin, DetailView):
+    """
+    A view allowing users to set up a batch-run of experiments involving a single entity.
+    """
+    permission_required = 'experiments.create_experiment'
+    context_object_name = 'entity'
+    template_name = 'entities/entity_runexperiments.html'
+
+    def get_context_data(self, **kwargs):
+        entity = self.object
+        context = super().get_context_data(**kwargs)
+
+        # preposition to use in sentence: You may run this entity on/under the following entities
+        context['preposition'] = 'under'
+        if entity.entity_type == 'protocol':
+            context['preposition'] = 'on'
+
+        # ended up using a nested dict as nested lists caused django's unpacking in forloops to
+        # mess things up slightly
+        other_entities = Entity.objects.filter(
+            entity_type=entity.other_type
+        ).select_related(
+            'cachedentity'
+        ).prefetch_related(
+            'cachedentity__versions',
+            'cachedentity__versions__tags'
+        )
+        context['object_list'] = []
+        context['other_object_list'] = []
+        for item in other_entities:
+            versions = item.cachedentity.versions
+            version_info = []
+            for version in versions.prefetch_related('tags'):
+                tag_list = list(version.tags.values_list('tag', flat=True))
+                commit = item.repo.get_commit(version.sha)
+                latest = item.repo.latest_commit
+                version_info.append({'commit': commit, 'tags': tag_list, 'latest': latest == commit})
+            if item.author == self.request.user:
+                context['object_list'].append({'id': item.id, 'name': item.name, 'versions': version_info})
+            else:
+                context['other_object_list'].append({'id': item.id, 'name': item.name, 'versions': version_info})
+        return context
+
+    def post(self, request, *args, **kwargs):
+        # this in not intuitive
+        # in get context self.object was the entity being worked with
+        # here we have to retrieve it
+        this_entity = self.get_object()
+        this_version = self.get_commit().hexsha
+        is_latest = (this_version == this_entity.repocache.latest_version.sha)
+        exclude_existing = 'rerun_expts' not in request.POST
+        experiments_to_run = request.POST.getlist('model_protocol_list[]')
+        for version in experiments_to_run:
+            ident, sha = version.split(':')
+            exper_kwargs = {
+                this_entity.other_type + '_id': ident,
+                this_entity.other_type + '_version': sha,
+                this_entity.entity_type + '_id': this_entity.id,
+                this_entity.entity_type + '_version': this_version,
+            }
+            if exclude_existing:
+                filter_kwargs = {
+                    'experiment__' + name: value
+                    for (name, value) in exper_kwargs.items()
+                }
+                if ExperimentVersion.objects.filter(**filter_kwargs).exists():
+                    continue
+            PlannedExperiment.objects.get_or_create(**exper_kwargs)
+        # return to entity page
+        version_to_use = 'latest'
+        if not is_latest:
+            version_to_use = kwargs['sha']
+        return HttpResponseRedirect(
+            reverse('entities:version', args=[kwargs['entity_type'], kwargs['pk'], version_to_use]))

weblab/static/js/main.js

@@ -10,6 +10,7 @@ var experiment = require('./experiment.js');
 var notifications = require('./lib/notifications.js');
 require('./compare.js');
 require('./entity_version_list.js');
+require('./run_experiment.js');
 require('django-formset');
 
 

weblab/static/js/run_experiment.js

@@ -0,0 +1,39 @@
+
+var RunExperiment = function() {};
+
+RunExperiment.prototype = {
+  init: function() {
+    $("#checkallbutton").click (function () {
+        $(".latestexperimentCheckBox").each (function () {
+            $(this).prop('checked', true)
+        });
+        $(".experimentCheckBox").each (function () {
+            $(this).prop('checked', true)
+        });
+    });
+    $("#uncheckallbutton").click (function () {
+        $(".latestexperimentCheckBox").each (function () {
+            $(this).prop('checked', false)
+        });
+        $(".experimentCheckBox").each (function () {
+            $(this).prop('checked', false)
+        });
+    });
+    $("#checklatestbutton").click (function () {
+        $(".latestexperimentCheckBox").each (function () {
+            $(this).prop('checked', true)
+        });
+        $(".experimentCheckBox").each (function () {
+            $(this).prop('checked', false)
+        });
+    });
+  }
+};
+
+
+$(document).ready(function() {
+  if ($("#runexperiment").length > 0) {
+    var page = new RunExperiment();
+    page.init();
+  }
+});

weblab/templates/entities/entity_runexperiments.html

@@ -0,0 +1,109 @@
+{% extends "base.html" %}
+{% load staticfiles %}
+{% load entities %}
+
+{% block title %}Experiment: run specific combinations - {% endblock title %}
+
+{% block body_id %}runexperiment{% endblock %}
+
+{% block content %}
+  <h1 id="entityname">Run experiments using <span>{{ entity.name }}</span></h1>
+
+    <button id="checkallbutton">check all</button>
+    <button id="checklatestbutton">check latest</button>
+    <button id="uncheckallbutton">uncheck all</button>
+  <form action="" method="post">
+    {% csrf_token %}
+    <button id="savebutton">run experiments</button>
+    <p>
+      <input class="overrideCheckBox" type="checkbox" name="rerun_expts"/>
+      Create new versions of existing experiments (if unchecked, existing combinations will be skipped)
+    </p>
+
+
+    <p>You may run this {{ type }} {{ preposition }} the following {{ other_type }}s.</p>
+
+    <h2> Your {{ other_type }}s</h2>
+
+    <!-- list each entity and all versions of that entity -->
+    {% for entity_object in object_list %}
+
+      <strong>{{ entity_object.name }}</strong>
+      <ul>
+        {% for entity_version in entity_object.versions %}
+
+          <li>
+            <p>
+              {% if entity_version.latest %}
+
+                <input class="latestexperimentCheckBox" type="checkbox"
+                       value="{{ entity_object.id }}:{{ entity_version.commit.hexsha }}"
+                       name="model_protocol_list[]"
+                       checked/>
+              {% else %}
+                <input class="experimentCheckBox" type="checkbox"
+                       value="{{ entity_object.id }}:{{ entity_version.commit.hexsha }}"
+                       name="model_protocol_list[]"/>
+              {% endif %}
+              <strong>
+                <a class="entityversionlink" href="{{ entity|url_version:entity_version.commit }}">
+                  {% include "./includes/version_name.html" with tags=entity_version.tags version=entity_version.commit only %}
+                </a>
+              </strong>
+              <span class="suppl"><small style="display: inline;">by <em>{{ entity_version.commit.author }}</em>
+                created <time>{{ entity_version.commit.committed_at }}</time></small></span><br/>
+              <span class="suppl">
+                {{ entity_version.commit.message|linebreaksbr }}
+              </span>
+            </p>
+          </li>
+        {% endfor %}
+      </ul>
+    {% endfor %}
+
+    <h2> Other {{ other_type }}s</h2>
+
+    <!-- list each entity and all versions of that entity -->
+    {% for entity_object in other_object_list %}
+
+      <strong>{{ entity_object.name }}</strong>
+      <ul>
+        {% for entity_version in entity_object.versions %}
+
+          <li>
+            <p>
+              {% if entity_version.latest %}
+
+                <input class="latestexperimentCheckBox" type="checkbox"
+                       value="{{ entity_object.id }}:{{ entity_version.commit.hexsha }}"
+                       name="model_protocol_list[]"
+                       checked/>
+              {% else %}
+                <input class="experimentCheckBox" type="checkbox"
+                       value="{{ entity_object.id }}:{{ entity_version.commit.hexsha }}"
+                       name="model_protocol_list[]"/>
+              {% endif %}
+              <strong>
+                <a class="entityversionlink" href="{{ entity|url_version:entity_version.commit }}">
+                  {% include "./includes/version_name.html" with tags=entity_version.tags version=entity_version.commit only %}
+                </a>
+              </strong>
+              by <em>{{ entity_version.commit.author }}</em><br/>
+              <span class="suppl">
+                      <small style="display: inline;">created </small> <time>{{ entity_version.commit.committed_at }}</time>
+                {% with entity_version.commit.filenames|length as numfiles %}
+                  <small style="display: inline;">containing</small> {{ numfiles }} file{{ numfiles|pluralize }}
+                {% endwith %}
+                  </span><br/>
+              <span class="suppl">
+                      {{ entity_version.commit.message|linebreaksbr }}
+                  </span>
+            </p>
+          </li>
+        {% endfor %}
+      </ul>
+    {% endfor %}
+
+  </form>
+
+{% endblock %}

weblab/templates/entities/entity_version.html

@@ -9,6 +9,7 @@
   {% include "./includes/entity_header.html" %}
   {% can_create_version entity as permission %}
 
+
   <div id="entitydetails">
   </div>
 
@@ -38,14 +39,21 @@ <h2 id="entityversionname">
         <div id="versionVisibility" data-change-href="{{ entity|url_change_version_visibility:version }}">
           {% if permission %}
             <a href="{{ entity|url_tag_version:version }}">Add tag</a>.
-            <form method="POST" action="">
+            <form method="POST" action="" style="display: inline;">
               Change visibility: {{ form.visibility }}
-              <img src="{% static 'img/info.png' %}" alt="help" title="{{ entity.VISIBILITY_HELP }}" />.
+              <img src="{% static 'img/info.png' %}" alt="help" title="{{ entity.VISIBILITY_HELP }}" />
               <span id="versionVisibilityAction"></span>
-            </form>
-          {% else %}
+           </form>
+           {% else %}
             Visibility: {{ visibility }}
-            <img src="{% static 'img/info.png' %}" alt="help" title="{{ entity.VISIBILITY_HELP }}" />.
+            <img src="{% static 'img/info.png' %}" alt="help" title="{{ entity.VISIBILITY_HELP }}" />
+          {% endif %}
+          {% if perms.experiments.create_experiment %}
+            Run experiments:
+            <a title="Run experiments" href="{{ entity|url_run_experiments:version }}">
+              <img src="{% static 'img/batch.png' %}" alt="Run experiments:"
+                   title="Run experiments using this {{ entity.entity_type }}"/>
+            </a>
           {% endif %}
         </div>
       </small>

weblab/templates/entities/includes/version_name.html

@@ -3,6 +3,6 @@
 {% for tag in tags %}
 <b>{{ tag }}</b>{% if not forloop.last %},{% endif %}
 {% endfor %}
-{% if tags %}<small>({% endif %}{% spaceless %}
+{% if tags %}<small style="display: inline;">({% endif %}{% spaceless %}
 <span title="Full identifier: {{ version.hexsha }}">{{ version.hexsha|truncatechars:11 }}</span>
 {% endspaceless %}{% if tags %})</small>{% endif %}