Merge pull request #381 from eReuse/features/3858-storage-management

Features/3858 storage management

ereuse_devicehub/inventory/forms.py

@@ -86,12 +86,18 @@ DEVICES = {
         "Smartphone",
         "Cellphone",
     ],
+    "Drives & Storage": [
+        "All DataStorage",
+        "HardDrives",
+        "SolidStageDrive",
+    ],
 }
 
 COMPUTERS = ['Desktop', 'Laptop', 'Server', 'Computer']
 
 MONITORS = ["ComputerMonitor", "Monitor", "TelevisionSet", "Projector"]
 MOBILE = ["Mobile", "Tablet", "Smartphone", "Cellphone"]
+STORAGE = ["HardDrive", "SolidStateDrive"]
 
 
 class AdvancedSearchForm(FlaskForm):
@@ -175,9 +181,16 @@ class FilterForm(FlaskForm):
         elif "All Mobile" == self.device_type:
             filter_type = MOBILE
 
+        elif "All DataStorage" == self.device_type:
+            filter_type = STORAGE
+
         if filter_type:
             self.devices = self.devices.filter(Device.type.in_(filter_type))
 
+        # if self.device_type in STORAGE + ["All DataStorage"]:
+        # import pdb; pdb.set_trace()
+        # self.devices = self.devices.filter(Component.parent_id.is_(None))
+
         return self.devices.order_by(Device.updated.desc())
 
 

ereuse_devicehub/inventory/views.py

@@ -296,6 +296,8 @@ class BindingView(GenericMixin):
         self.real_phid = self.new_placeholder.phid
         self.abstract_dhid = self.old_device.devicehub_id
         self.abstract_phid = self.old_placeholder.phid
+        if self.old_placeholder.kangaroo:
+            self.new_placeholder.kangaroo = True
 
         # to do a backup of abstract_dhid and abstract_phid in
         # workbench device
@@ -383,6 +385,9 @@ class UnBindingView(GenericMixin):
         if device.binding.is_abstract:
             return
 
+        kangaroo = device.binding.kangaroo
+        device.binding.kangaroo = False
+
         dict_device = copy.copy(device.__dict__)
         dict_device.pop('_sa_instance_state')
         dict_device.pop('id', None)
@@ -402,7 +407,10 @@ class UnBindingView(GenericMixin):
                 if c.binding:
                     c.binding.device.parent = new_device
 
-        placeholder = Placeholder(device=new_device, binding=device, is_abstract=True)
+        placeholder = Placeholder(
+            device=new_device, binding=device, is_abstract=True, kangaroo=kangaroo
+        )
+
         if (
             device.dhid_bk
             and not Device.query.filter_by(devicehub_id=device.dhid_bk).first()

ereuse_devicehub/migrations/versions/a13ed6ad0e3e_add_kangaroo_in_placeholder.py

@@ -0,0 +1,34 @@
+"""add kangaroo in placeholder
+
+Revision ID: a13ed6ad0e3e
+Revises: 626c17026ca7
+Create Date: 2022-10-13 11:56:15.303218
+
+"""
+import sqlalchemy as sa
+from alembic import context, op
+
+# revision identifiers, used by Alembic.
+revision = 'a13ed6ad0e3e'
+down_revision = '626c17026ca7'
+branch_labels = None
+depends_on = None
+
+
+def get_inv():
+    INV = context.get_x_argument(as_dictionary=True).get('inventory')
+    if not INV:
+        raise ValueError("Inventory value is not specified")
+    return INV
+
+
+def upgrade():
+    op.add_column(
+        'placeholder',
+        sa.Column('kangaroo', sa.Boolean(), nullable=True),
+        schema=f'{get_inv()}',
+    )
+
+
+def downgrade():
+    op.drop_column('placeholder', 'kangaroo', schema=f'{get_inv()}')

ereuse_devicehub/resources/device/models.py

@@ -932,6 +932,7 @@ class Placeholder(Thing):
     )
     id_device_internal = db.Column(CIText())
     id_device_internal.comment = "Identification used internaly for the user"
+    kangaroo = db.Column(Boolean, default=False, nullable=True)
 
     device_id = db.Column(
         BigInteger,

ereuse_devicehub/templates/inventory/device_list.html

@@ -357,6 +357,7 @@
                   </thead>
                   <tbody>
                     {% for dev in devices %}
+                    {% if not dev.parent_id or dev.parent.placeholder.kangaroo %}
                     <tr>
                       <td>
                           <input type="checkbox" class="deviceSelect" data="{{ dev.id }}"
@@ -410,6 +411,7 @@
                         </a>
                       </td>
                     </tr>
+                    {% endif %}
                     {% endfor %}
                   </tbody>
                 </table>

ereuse_devicehub/templates/workbench/settings.html

@@ -11,6 +11,62 @@
 </div><!-- End Page Title -->
 
 <section class="section profile">
+  <div class="row">
+    <div class="col-xl-6">
+
+      <div class="card">
+        <div class="card-body">
+
+          <div class="pt-6 pb-2">
+            <div class="row pt-3">
+              <div class="col">
+                <form method="post">
+                <table class="table table-hover">
+                  <thead>
+                    <tr>
+                      <th scope="col">PHID</th>
+                      <th scope="col" class="text-center">Erasure Host</th>
+                    </tr>
+                  </thead>
+                  <tbody>
+                  {% for host in form.kangaroos %}
+                  <tr>
+                    <td>{{ host.phid }}</td>
+                    <td class="text-center">
+                      <a href="{{ url_for('workbench.erasure_host', id=host.id) }}"><i class="bi bi-x-lg"></i></a>
+                    </td>
+                  </tr>
+                  {% endfor %}
+                  <tr>
+                    <td>
+                      {% for f in form %}
+                        {{ f }}
+                        {% if f == form.phid and f.errors %}
+                          <p class="text-danger">
+                            {% for error in f.errors %}
+                              {{ error }}<br/>
+                            {% endfor %}
+                          </p>
+                        {% endif %}
+                      {% endfor %}
+                    </td>
+                    <td class="text-center">
+                      <input type="submit" class="btn btn-primary" value="Add new host" />
+                    </td>
+                  </tr>
+                  </tbody>
+                </table>
+                </form>
+              </div>
+            </div>
+          </div>
+
+        </div>
+      </div>
+
+    </div>
+  </div>
+
   <div class="row">
     <div class="col-xl-6">
 

ereuse_devicehub/workbench/forms.py

@@ -0,0 +1,47 @@
+from flask import g
+from flask_wtf import FlaskForm
+from wtforms import StringField, validators
+
+from ereuse_devicehub.db import db
+from ereuse_devicehub.resources.device.models import Placeholder
+
+
+class KangarooForm(FlaskForm):
+    phid = StringField('Phid', [validators.length(min=1)])
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.placeholder = None
+        self.kangaroos = Placeholder.query.filter(
+            Placeholder.kangaroo.is_(True)
+        ).filter(Placeholder.owner_id == g.user.id)
+
+    def validate(self, extra_validators=None):
+        is_valid = super().validate(extra_validators)
+        if not is_valid:
+            return False
+
+        if not self.placeholder:
+            self.placeholder = (
+                Placeholder.query.filter(Placeholder.phid == self.phid.data)
+                .filter(Placeholder.owner_id == g.user.id)
+                .first()
+            )
+            if self.placeholder:
+                if self.placeholder.status not in ['Snapshot', 'Twin']:
+                    self.placeholder = None
+
+        if not self.placeholder:
+            self.phid.errors = ["Device not exist"]
+            return False
+
+        return True
+
+    def save(self):
+        if not self.placeholder or self.placeholder.kangaroo:
+            return
+
+        self.placeholder.kangaroo = True
+        db.session.commit()
+        return self.placeholder

ereuse_devicehub/workbench/views.py

@@ -3,34 +3,43 @@ import time
 import flask
 from flask import Blueprint
 from flask import current_app as app
-from flask import g, make_response, request
+from flask import g, make_response, request, url_for
+from flask.views import View
 from flask_login import login_required
 
 from ereuse_devicehub import auth
 from ereuse_devicehub.db import db
+from ereuse_devicehub.resources.device.models import Placeholder
 from ereuse_devicehub.resources.enums import SessionType
 from ereuse_devicehub.resources.user.models import Session
 from ereuse_devicehub.views import GenericMixin
 from ereuse_devicehub.workbench import isos
+from ereuse_devicehub.workbench.forms import KangarooForm
 
 workbench = Blueprint('workbench', __name__, url_prefix='/workbench')
 
 
 class SettingsView(GenericMixin):
     decorators = [login_required]
+    methods = ['GET', 'POST']
     template_name = 'workbench/settings.html'
     page_title = "Workbench"
 
     def dispatch_request(self):
         self.get_context()
+        form_kangaroo = KangarooForm()
         self.context.update(
             {
                 'page_title': self.page_title,
                 'demo': g.user.email == app.config['EMAIL_DEMO'],
                 'iso': isos,
+                'form': form_kangaroo,
             }
         )
 
+        if form_kangaroo.validate_on_submit():
+            form_kangaroo.save()
+
         self.opt = request.values.get('opt')
         if self.opt in ['register', 'erease_basic', 'erease_sectors']:
             return self.download()
@@ -86,4 +95,24 @@ class SettingsView(GenericMixin):
         return token
 
 
+class ErasureHostView(View):
+    decorators = [login_required]
+    methods = ['GET']
+
+    def dispatch_request(self, id):
+        self.placeholder = (
+            Placeholder.query.filter(Placeholder.id == id)
+            .filter(Placeholder.kangaroo.is_(True))
+            .filter(Placeholder.owner_id == g.user.id)
+            .one()
+        )
+        self.placeholder.kangaroo = False
+        db.session.commit()
+
+        return flask.redirect(url_for('workbench.settings'))
+
+
 workbench.add_url_rule('/', view_func=SettingsView.as_view('settings'))
+workbench.add_url_rule(
+    '/erasure_host/<int:id>/', view_func=ErasureHostView.as_view('erasure_host')
+)

tests/test_basic.py

@@ -105,6 +105,7 @@ def test_api_docs(client: Client):
         '/users/logout/',
         '/versions/',
         '/workbench/',
+        '/workbench/erasure_host/{id}/',
     }
     assert docs['info'] == {'title': 'Devicehub', 'version': '0.2'}
     assert docs['components']['securitySchemes']['bearerAuth'] == {

tests/test_render_2_0.py

@@ -2438,3 +2438,99 @@ def test_bug_3831_documents(user3: UserClientFlask):
     uri = f'/inventory/lot/{lot_id}/trade-document/add/'
     # body, status = user3.post(uri, data=data, content_type="multipart/form-data")
     # assert status == '200 OK'
+
+
+@pytest.mark.mvp
+@pytest.mark.usefixtures(conftest.app_context.__name__)
+def test_hdd_filter(user3: UserClientFlask):
+    create_device(user3, 'real-eee-1001pxd.snapshot.12.json')
+
+    hdds = Device.query.filter_by(type='HardDrive').all()
+    for hdd in hdds:
+        hdd.parent = None
+    db.session.commit()
+
+    csrf = generate_csrf()
+    uri = f'/inventory/device/?filter=All+DataStorage&csrf_token={csrf}'
+    body, status = user3.get(uri)
+
+    assert status == '200 OK'
+    for hdd in hdds:
+        assert hdd.dhid in body
+
+
+@pytest.mark.mvp
+@pytest.mark.usefixtures(conftest.app_context.__name__)
+def test_add_kangaroo(user3: UserClientFlask):
+    create_device(user3, 'real-eee-1001pxd.snapshot.12.json')
+
+    body, status = user3.get('/workbench/')
+
+    assert status == '200 OK'
+
+    pc = Device.query.filter_by(type='Laptop').first()
+    data = {
+        'csrf_token': generate_csrf(),
+        'phid': pc.phid(),
+    }
+
+    body, status = user3.post('/workbench/', data=data)
+    assert status == '200 OK'
+    assert pc.phid() in body
+
+
+@pytest.mark.mvp
+@pytest.mark.usefixtures(conftest.app_context.__name__)
+def test_drop_kangaroo(user3: UserClientFlask):
+    create_device(user3, 'real-eee-1001pxd.snapshot.12.json')
+    pc = Device.query.filter_by(type='Laptop').first()
+    phid = 'AAA'
+    pc.placeholder.phid = phid
+    db.session.commit()
+
+    body, status = user3.get('/workbench/')
+    assert phid not in body
+
+    data = {
+        'csrf_token': generate_csrf(),
+        'phid': phid,
+    }
+
+    body, status = user3.post('/workbench/', data=data)
+    assert status == '200 OK'
+    assert phid in body
+
+    placeholder_id = pc.placeholder.id
+    uri = f'/workbench/erasure_host/{placeholder_id}/'
+    body, status = user3.get(uri)
+    assert status == '200 OK'
+    assert phid not in body
+
+
+@pytest.mark.mvp
+@pytest.mark.usefixtures(conftest.app_context.__name__)
+def test_filter_hdd_in_kangaroo(user3: UserClientFlask):
+    create_device(user3, 'real-eee-1001pxd.snapshot.12.json')
+    csrf = generate_csrf()
+    uri = f'/inventory/device/?filter=All+DataStorage&csrf_token={csrf}'
+    body, status = user3.get(uri)
+
+    assert status == '200 OK'
+    for hdd in Device.query.filter_by(type='HardDrive').all():
+        assert hdd.dhid not in body
+
+    user3.get('/workbench/')
+    pc = Device.query.filter_by(type='Laptop').first()
+    data = {
+        'csrf_token': generate_csrf(),
+        'phid': pc.phid(),
+    }
+    user3.post('/workbench/', data=data)
+
+    csrf = generate_csrf()
+    uri = f'/inventory/device/?filter=All+DataStorage&csrf_token={csrf}'
+    body, status = user3.get(uri)
+
+    assert status == '200 OK'
+    for hdd in Device.query.filter_by(type='HardDrive').all():
+        assert hdd.dhid in body