aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-14 23:43:57 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-14 23:43:57 +0000
commit48a9c67f9302694ce25fca074baa38cc2582f437 (patch)
treeccc1531cd4039e6977ad1df4849c91fe36ba3794
parent24998b98340cdfa7bc52b99536b70351b1604479 (diff)
downloadpaludis-48a9c67f9302694ce25fca074baa38cc2582f437.tar.gz
paludis-48a9c67f9302694ce25fca074baa38cc2582f437.tar.xz
Add a check that DESCRIPTION is set and a sane length. This is a good one to copy for other basic non-dependency metadata validation checks.
-rw-r--r--paludis/qa/description_check.cc69
-rw-r--r--paludis/qa/description_check.hh51
-rw-r--r--paludis/qa/files.m41
3 files changed, 121 insertions, 0 deletions
diff --git a/paludis/qa/description_check.cc b/paludis/qa/description_check.cc
new file mode 100644
index 0000000..e59386d
--- /dev/null
+++ b/paludis/qa/description_check.cc
@@ -0,0 +1,69 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2006 Ciaran McCreesh <ciaranm@gentoo.org>
+ *
+ * This file is part of the Paludis package manager. Paludis is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU General
+ * Public License version 2, as published by the Free Software Foundation.
+ *
+ * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#include "description_check.hh"
+
+using namespace paludis;
+using namespace paludis::qa;
+
+DescriptionCheck::DescriptionCheck()
+{
+}
+
+CheckResult
+DescriptionCheck::operator() (const EbuildCheckData & e) const
+{
+ CheckResult result(stringify(e.get<ecd_name>()) + "-" + stringify(e.get<ecd_version>()),
+ identifier());
+
+ try
+ {
+ PackageDatabaseEntry ee(e.get<ecd_name>(), e.get<ecd_version>(),
+ e.get<ecd_environment>()->package_database()->favourite_repository());
+ VersionMetadata::ConstPointer metadata(
+ e.get<ecd_environment>()->package_database()->fetch_metadata(ee));
+
+ if (0 == metadata->get(vmk_description).length())
+ result << Message(qal_major, "DESCRIPTION unset or empty");
+ else if (metadata->get(vmk_description).length() < 10)
+ result << Message(qal_minor, "DESCRIPTION suspiciously short");
+ else if (metadata->get(vmk_description).length() > 80)
+ result << Message(qal_minor, "DESCRIPTION too long");
+
+ }
+ catch (const InternalError &)
+ {
+ throw;
+ }
+ catch (const Exception & e)
+ {
+ result << Message(qal_fatal, "Caught Exception '" + e.message() + "' ("
+ + e.what() + ")");
+ }
+
+ return result;
+}
+
+const std::string &
+DescriptionCheck::identifier()
+{
+ static const std::string id("description");
+ return id;
+}
+
diff --git a/paludis/qa/description_check.hh b/paludis/qa/description_check.hh
new file mode 100644
index 0000000..3e6e9ae
--- /dev/null
+++ b/paludis/qa/description_check.hh
@@ -0,0 +1,51 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2006 Ciaran McCreesh <ciaranm@gentoo.org>
+ *
+ * This file is part of the Paludis package manager. Paludis is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU General
+ * Public License version 2, as published by the Free Software Foundation.
+ *
+ * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef PALUDIS_GUARD_PALUDIS_QA_DESCRIPTION_CHECK_HH
+#define PALUDIS_GUARD_PALUDIS_QA_DESCRIPTION_CHECK_HH 1
+
+#include <paludis/qa/ebuild_check.hh>
+#include <string>
+
+namespace paludis
+{
+ namespace qa
+ {
+ class DescriptionCheck :
+ public EbuildCheck
+ {
+ public:
+ DescriptionCheck();
+
+ CheckResult operator() (const EbuildCheckData &) const;
+
+ static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that DESCRIPTION is sane";
+ }
+ };
+
+ static const EbuildCheckMaker::RegisterMaker register_description_check(
+ DescriptionCheck::identifier(), &make_ebuild_check<DescriptionCheck>);
+ }
+}
+
+#endif
diff --git a/paludis/qa/files.m4 b/paludis/qa/files.m4
index 8b8a448..819a6ec 100644
--- a/paludis/qa/files.m4
+++ b/paludis/qa/files.m4
@@ -12,6 +12,7 @@ add(`changelog_check', `hh', `cc')
add(`check', `hh', `cc')
add(`check_result', `hh', `cc', `test')
add(`create_metadata_check', `hh', `cc')
+add(`description_check', `hh', `cc')
add(`ebuild_check', `hh', `cc')
add(`environment', `hh', `cc')
add(`file_check', `hh', `cc')