[fix] Added fields to the header

Author: pandafy

openwisp_users/management/commands/export_users.py

@@ -27,6 +27,17 @@ def _normalize_value(value):
         """Convert None to empty string, otherwise stringify the value."""
         return "" if value is None else str(value)
 
+    @staticmethod
+    def _get_header(field):
+        normalized = normalize_field(field)
+        header = normalized.get("header")
+        if header:
+            return header
+        header_fields = normalized.get("header_fields") or normalized.get("fields")
+        if header_fields:
+            return f"{normalized['name']} ({', '.join(header_fields)})"
+        return normalized["name"]
+
     def add_arguments(self, parser):
         parser.add_argument(
             "--exclude-fields",
@@ -72,7 +83,7 @@ def handle(self, *args, **options):
         with open(filename, "w", newline="", encoding="utf-8") as csv_file:
             csv_writer = csv.writer(csv_file)
             # Write header row using the name of each field
-            csv_writer.writerow([normalize_field(f)["name"] for f in fields])
+            csv_writer.writerow([self._get_header(f) for f in fields])
 
             # Write data rows
             for user in queryset.iterator(chunk_size=1000):

openwisp_users/settings.py

@@ -44,7 +44,11 @@ def export_organizations(user):
             "location",
             "notes",
             "language",
-            {"name": "organizations", "callable": export_organizations},
+            {
+                "name": "organizations",
+                "header_fields": ["organization_id", "is_admin"],
+                "callable": export_organizations,
+            },
         ],
         "select_related": [],
         "prefetch_related": ["openwisp_users_organizationuser"],

openwisp_users/tests/test_commands.py

@@ -67,7 +67,7 @@ def test_export_users(self):
             "location",
             "notes",
             "language",
-            "organizations",
+            "organizations (organization_id, is_admin)",
         ]
         self.assertEqual(csv_data[0], expected_headers)
         # Ensuring ordering
@@ -265,6 +265,16 @@ def test_subfields_dict_field(self):
             csv_data = list(csv_reader)
         # 2 users + 1 header
         self.assertEqual(len(csv_data), 3)
+        expected_headers = [
+            "id",
+            "auth_token (key)",
+            "auth_token (key, created)",
+            "birth_date (year)",
+            "openwisp_users_organizationuser (organization_id)",
+            "openwisp_users_organizationuser (organization_id, is_admin)",
+            "openwisp_users_organizationuser.organization_id",
+        ]
+        self.assertEqual(csv_data[0], expected_headers)
         # user1: token present, birth_date None, one org membership
         self.assertEqual(csv_data[1][0], str(user1.id))
         # subfields, single obj
@@ -318,3 +328,37 @@ def test_plain_relation_field_returns_empty_string(self):
         self._create_org_user(organization=org, user=user, is_admin=True)
         result = Command()._get_field_value(user, "openwisp_users_organizationuser")
         self.assertEqual(result, "")
+
+    @capture_stdout()
+    def test_custom_header(self):
+        def _get_is_active(user):
+            return "yes" if user.is_active else "no"
+
+        config = {
+            "fields": [
+                "id",
+                {
+                    "name": "active_status",
+                    "header": "Active?",
+                    "callable": _get_is_active,
+                },
+                {
+                    "name": "custom_orgs",
+                    "header_fields": ["org_id", "is_admin"],
+                    "callable": _get_is_active,
+                },
+            ],
+            "select_related": [],
+            "prefetch_related": [],
+        }
+        self._create_user(is_active=True)
+        with patch.object(app_settings, "EXPORT_USERS_COMMAND_CONFIG", config):
+            call_command("export_users", filename=self.temp_file.name)
+        with open(self.temp_file.name, "r", encoding="utf-8") as f:
+            csv_reader = csv.reader(f)
+            csv_data = list(csv_reader)
+        self.assertEqual(
+            csv_data[0], ["id", "Active?", "custom_orgs (org_id, is_admin)"]
+        )
+        self.assertEqual(csv_data[1][1], "yes")
+        self.assertEqual(csv_data[1][2], "yes")