Page MenuHomePhabricator
Create Task
Maniphest T179554

Add phan to MediaWiki extensions and skins for static analysis [cloneable]
Closed, ResolvedPublic
Actions

Description

This is a clonable task for Google-Code-in-2017

Phan is a PHP static analysis tool that can identify problems with code without actually executing it. We use it in MediaWiki core and a few other extensions, and I'd like to add it to more. The process is generally straightforward.

Please use the Gerrit topic of "phan" for your commits.

A more in-depth tutorial can be found at https://www.mediawiki.org/wiki/Continuous_integration/Tutorials/Add_phan_to_a_MediaWiki_extension

First we can start with the tarball bundled extensions and skins:

  • Cite
  • CiteThisPage
  • ConfirmEdit
  • Gadgets
  • ImageMap
  • InputBox
  • Interwiki
  • LocalisationUpdate
  • Nuke
  • ParserFunctions
  • PdfHandler
  • Poem
  • Renameuser
  • SpamBlacklist
  • SyntaxHighlight_GeSHi
  • TitleBlacklist
  • WikiEditor
  • CologneBlue skin
  • MonoBook skin
  • Modern skin
  • Vector skin

Details

Show related patches Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedNoneT179554 Add phan to MediaWiki extensions and skins for static analysis [cloneable]
 ResolvedUmherirrenderT224783 Enable mediawiki/mediawiki-phan-config on all Wikimedia-deployed repositories
 ResolvedMaxSemT217018 Upgrade Wikibase extension to use newer phan
 ResolvedDaimonaT224775 Use mediawiki/mediawiki-phan-config in extension WikibaseLexeme
ResolvedDaimonaT189371 phan and taint/sec for CentralAuth
 ResolvedDaimonaT189227 taint-checks for CentralAuth failing
 ResolvedDaimonaT224759 Add phan to Flow extension
 ResolvedDaimonaT224758 Add phan to ProofreadPage extension
 ResolvedUmherirrenderT224756 Add phan to Translate extension
 ResolvedUmherirrenderT224757 Add phan to LiquidThreads extension
 ResolvedUmherirrenderT224761 Add phan to OAuth extension
 ResolvedUmherirrenderT224762 Add phan to ReadingLists extension
 ResolvedEjeggT224763 Add phan to DonationInterface extension
 ResolvedUmherirrenderT224765 Add phan to OpenStackManager extension
 ResolvedUmherirrenderT224766 Add phan to TimedMediaHandler extension
 DeclinedNoneT224767 Add phan to CodeReview extension
 ResolvedUmherirrenderT224768 Add phan to JsonConfig extension
 ResolvedUmherirrenderT224769 Add phan to FlaggedRevs extension
 ResolvedUmherirrenderT224770 Add phan to WikimediaMaintenance extension
 ResolvedUmherirrenderT224772 Add phan to WikibaseMediaInfo extension
 ResolvedUmherirrenderT224773 Add phan to WikibaseQualityConstraints extension
 ResolvedUmherirrenderT224774 Add phan to PropertySuggester extension
 ResolvedUmherirrenderT224779 Add phan to CentralNotice extension
 ResolvedUmherirrenderT224778 Add phan to EventBus extension
 ResolvedUmherirrenderT224777 Add phan to WikimediaIncubator extension
 ResolvedUmherirrenderT224776 Add phan to LdapAuthentication extension
 ResolvedLegoktmT224780 Add phan to CologneBlue skin
 ResolvedLegoktmT224781 Add phan to Nostalgia skin
 ResolvedDaimonaT133664 Statically analyse MinervaNeue codebases with Phan
 ResolvedEBernhardsonT153252 Fix PHP issues in MediaWiki core found by Phan (static code analysis)

Event Timeline

Legoktm created this task.Nov 2 2017, 1:27 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 2 2017, 1:27 AM
• MZMcBride subscribed.Nov 2 2017, 4:54 AM
Liuxinyu970226 subscribed.Nov 2 2017, 5:07 AM
Addshore subscribed.Nov 2 2017, 12:58 PM

I can mentor / help mentor this (@Legoktm)

Florian subscribed.EditedNov 14 2017, 7:26 PM
In T179554#3729350, @Addshore wrote:

I can mentor / help mentor this (@Legoktm)

Me, too! :)

One question remains: What do you think about acceptance criteria: When does a student know, that he finished this task? Something like: Add phan to at least one extension/skin? :)

Florian moved this task from Proposed tasks to Information needed on the Google-Code-in-2017 board.Nov 14 2017, 7:28 PM
Aklapper renamed this task from Add phan to MediaWiki extensions for static analysis to Add phan to MediaWiki extensions and skins for static analysis [cloneable].Nov 20 2017, 11:47 AM
Aklapper edited projects, added MediaWiki-extensions-General; removed MediaWiki-extension-requests.
Aklapper updated the task description. (Show Details)
Aklapper moved this task from Information needed to Imported in GCI Site on the Google-Code-in-2017 board.Nov 20 2017, 12:00 PM

Let's go for two extensions/skins per GCI task. Imported:
https://codein.withgoogle.com/tasks/5652788950335488/
https://codein.withgoogle.com/tasks/5677912999067648/
https://codein.withgoogle.com/tasks/6046218155196416/
https://codein.withgoogle.com/tasks/5743122581553152/
https://codein.withgoogle.com/tasks/5677870217166848/
https://codein.withgoogle.com/tasks/5718303408390144/
https://codein.withgoogle.com/tasks/5761666908160000/
https://codein.withgoogle.com/tasks/5367147855347712/
https://codein.withgoogle.com/tasks/5745867434754048/
https://codein.withgoogle.com/tasks/5086997339176960/

gerritbot subscribed.Dec 24 2017, 3:00 AM

Change 400079 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[mediawiki/extensions/SyntaxHighlight_GeSHi@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400079

gerritbot added a project: Patch-For-Review.Dec 24 2017, 3:00 AM

Change 400080 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/ParserMigration

https://gerrit.wikimedia.org/r/400080

gerritbot added a comment.Dec 24 2017, 3:18 AM

Change 400081 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[mediawiki/extensions/TitleBlacklist@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400081

gerritbot added a comment.Dec 24 2017, 3:20 AM

Change 400082 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/TitleBlackList

https://gerrit.wikimedia.org/r/400082

gerritbot added a comment.Dec 24 2017, 3:36 AM

Change 400083 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[mediawiki/extensions/WikiEditor@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400083

gerritbot added a comment.Dec 24 2017, 3:39 AM

Change 400084 had a related patch set uploaded (by Rafidaslam; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/WikiEditor

https://gerrit.wikimedia.org/r/400084

eflyjason subscribed.Dec 25 2017, 1:43 AM

Is there any way we could use phan in MediaWiki-Vagrant which still runs PHP 5?

Bawolff subscribed.Dec 25 2017, 1:46 AM
In T179554#3860205, @eflyjason wrote:

Is there any way we could use phan in MediaWiki-Vagrant which still runs PHP 5?

Mediawiki-vagrant is using hhvm not php5, but the question still stands.

Basically you can install php7.0 there is instructions at
https://www.mediawiki.org/wiki/Continuous_integration/Phan#Dependencies

Legoktm added a comment.Dec 25 2017, 1:48 AM

See https://lists.wikimedia.org/pipermail/wikitech-l/2017-December/089294.html - you can try out the stretch version of MediaWiki-Vagrant that comes with PHP 7.0 (but it may also have some bugs in it)

gerritbot added a comment.Dec 25 2017, 6:20 AM

Change 400156 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[mediawiki/skins/Vector@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400156

gerritbot added a comment.Dec 25 2017, 6:29 AM

Change 400157 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/skins/Vector

https://gerrit.wikimedia.org/r/400157

gerritbot added a comment.Dec 25 2017, 6:50 AM

Change 400158 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[mediawiki/skins/Modern@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400158

gerritbot added a comment.Dec 25 2017, 6:53 AM

Change 400159 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/skins/Modern

https://gerrit.wikimedia.org/r/400159

gerritbot added a comment.Dec 25 2017, 1:24 PM

Change 400174 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[mediawiki/extensions/Cite@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400174

gerritbot added a comment.Dec 25 2017, 4:04 PM

Change 400185 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[mediawiki/extensions/CiteThisPage@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400185

gerritbot added a comment.Dec 25 2017, 4:09 PM

Change 400186 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/extensions/Cite

https://gerrit.wikimedia.org/r/400186

gerritbot added a comment.Dec 25 2017, 4:11 PM

Change 400187 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/extensions/CiteThisPage

https://gerrit.wikimedia.org/r/400187

xSavitar subscribed.Dec 25 2017, 4:51 PM
gerritbot added a comment.Dec 25 2017, 7:42 PM

Change 400187 had a related patch set uploaded (by Legoktm; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/extensions/CiteThisPage

https://gerrit.wikimedia.org/r/400187

gerritbot added a comment.Dec 25 2017, 7:42 PM

Change 400186 had a related patch set uploaded (by Legoktm; owner: Phantom42):
[integration/config@master] Run phan for mediawiki/extensions/Cite

https://gerrit.wikimedia.org/r/400186

gerritbot added a comment.Dec 25 2017, 7:42 PM

Change 400084 had a related patch set uploaded (by Legoktm; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/WikiEditor

https://gerrit.wikimedia.org/r/400084

gerritbot added a comment.Dec 25 2017, 7:42 PM

Change 400082 had a related patch set uploaded (by Legoktm; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/TitleBlackList

https://gerrit.wikimedia.org/r/400082

gerritbot added a comment.Dec 25 2017, 7:42 PM

Change 400080 had a related patch set uploaded (by Legoktm; owner: Rafid Aslam):
[integration/config@master] Run phan for mediawiki/extensions/SyntaxHighlight_GeSHi

https://gerrit.wikimedia.org/r/400080

gerritbot added a comment.Dec 25 2017, 7:44 PM

Change 400187 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/extensions/CiteThisPage

https://gerrit.wikimedia.org/r/400187

gerritbot added a comment.Dec 25 2017, 7:44 PM

Change 400186 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/extensions/Cite

https://gerrit.wikimedia.org/r/400186

gerritbot added a comment.Dec 25 2017, 7:44 PM

Change 400084 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/extensions/WikiEditor

https://gerrit.wikimedia.org/r/400084

gerritbot added a comment.Dec 25 2017, 7:44 PM

Change 400082 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/extensions/TitleBlackList

https://gerrit.wikimedia.org/r/400082

gerritbot added a comment.Dec 25 2017, 7:44 PM

Change 400080 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/extensions/SyntaxHighlight_GeSHi

https://gerrit.wikimedia.org/r/400080

gerritbot added a comment.Dec 25 2017, 7:48 PM

Change 400083 merged by jenkins-bot:
[mediawiki/extensions/WikiEditor@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400083

gerritbot added a comment.Dec 25 2017, 7:50 PM

Change 400081 merged by jenkins-bot:
[mediawiki/extensions/TitleBlacklist@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400081

gerritbot added a comment.Dec 25 2017, 7:50 PM

Change 400079 merged by jenkins-bot:
[mediawiki/extensions/SyntaxHighlight_GeSHi@master] Add phan configuration for static analysis and fix phan warnings

https://gerrit.wikimedia.org/r/400079

gerritbot added a comment.Dec 25 2017, 7:50 PM

Change 400185 merged by jenkins-bot:
[mediawiki/extensions/CiteThisPage@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400185

ReleaseTaggerBot added a project: MW-1.31-release-notes (WMF-deploy-2018-01-02 (1.31.0-wmf.15)).Dec 25 2017, 8:00 PM
Legoktm updated the task description. (Show Details)Dec 25 2017, 10:08 PM
Legoktm updated the task description. (Show Details)
Legoktm updated the task description. (Show Details)
gerritbot added a comment.Dec 29 2017, 8:06 PM

Change 400174 merged by jenkins-bot:
[mediawiki/extensions/Cite@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400174

gerritbot added a comment.Jan 14 2018, 8:03 PM

Change 404170 had a related patch set uploaded (by Zoranzoki21; owner: Zoranzoki21):
[mediawiki/skins/CologneBlue@master] Add phan for skin CologneBlue

https://gerrit.wikimedia.org/r/404170

gerritbot added a comment.Jan 14 2018, 8:04 PM

Change 404171 had a related patch set uploaded (by Zoranzoki21; owner: Zoranzoki21):
[mediawiki/skins/MonoBook@master] Add phan for MonoBook skin

https://gerrit.wikimedia.org/r/404171

gerritbot added a comment.Jan 14 2018, 8:07 PM

Change 404172 had a related patch set uploaded (by Zoranzoki21; owner: Zoranzoki21):
[integration/config@master] Run phan for CologneBlue and MonoBook skins

https://gerrit.wikimedia.org/r/404172

Kizule moved this task from Backlog to In progress on the Continuous-Integration-Config board.Jan 14 2018, 9:12 PM
gerritbot added a comment.Jan 17 2018, 7:10 PM

Change 404171 abandoned by Zoranzoki21:
Add phan for MonoBook skin

Reason:
I no want to work on this

https://gerrit.wikimedia.org/r/404171

gerritbot added a comment.Jan 17 2018, 7:10 PM

Change 404170 abandoned by Zoranzoki21:
Add phan for skin CologneBlue

Reason:
I no want to work on this anymore

https://gerrit.wikimedia.org/r/404170

gerritbot added a comment.Jan 17 2018, 7:10 PM

Change 404172 abandoned by Zoranzoki21:
Run phan for CologneBlue and MonoBook skins

Reason:
Only I lost time.

https://gerrit.wikimedia.org/r/404172

Legoktm updated the task description. (Show Details)Feb 24 2018, 7:47 PM
Legoktm updated the task description. (Show Details)Feb 25 2018, 12:50 AM
Legoktm updated the task description. (Show Details)Feb 25 2018, 3:16 AM
Legoktm removed projects: MW-1.31-release-notes (WMF-deploy-2018-01-02 (1.31.0-wmf.15)), Patch-For-Review.
gerritbot added a comment.May 2 2018, 7:07 AM

Change 400157 abandoned by Legoktm:
[Vector] Run phan

Reason:
Done in https://gerrit.wikimedia.org/r/430295

https://gerrit.wikimedia.org/r/400157

Beeyan subscribed.May 2 2018, 2:57 PM
Beeyan unsubscribed.
gerritbot added a comment.May 2 2018, 9:51 PM

Change 400156 merged by jenkins-bot:
[mediawiki/skins/Vector@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400156

ReleaseTaggerBot added a project: MW-1.32-notes (WMF-deploy-2018-05-08 (1.32.0-wmf.3)).May 2 2018, 10:00 PM
gerritbot added a comment.May 3 2018, 4:08 AM

Change 400159 merged by jenkins-bot:
[integration/config@master] Run phan for mediawiki/skins/Modern

https://gerrit.wikimedia.org/r/400159

Legoktm updated the task description. (Show Details)May 3 2018, 4:15 AM
gerritbot added a comment.May 3 2018, 4:19 AM

Change 400158 merged by jenkins-bot:
[mediawiki/skins/Modern@master] Add phan configuration for static analysis

https://gerrit.wikimedia.org/r/400158

Tgr subscribed.Feb 26 2019, 3:51 AM

Should this be closed as resolved, or moved to Outreach-Programs-Projects?

Umherirrender updated the task description. (Show Details)May 31 2019, 1:28 PM
Umherirrender added a subtask: T224783: Enable mediawiki/mediawiki-phan-config on all Wikimedia-deployed repositories.May 31 2019, 9:40 PM
Gopavasanth updated the task description. (Show Details)Oct 11 2019, 6:36 PM
Umherirrender closed subtask T224783: Enable mediawiki/mediawiki-phan-config on all Wikimedia-deployed repositories as Resolved.Oct 31 2019, 5:38 PM
Reedy mentioned this in T246949: Security Review Request for WikimediaApiPortal Skin.Apr 12 2020, 5:51 PM
hashar closed this task as Resolved.May 4 2020, 10:40 PM
hashar moved this task from In progress to Repo setup on the Continuous-Integration-Config board.
hashar added subscribers: Daimona, Umherirrender, hashar.

As I understand it, this task was for Google Summer of Code 2017 and intended to be cloneable for students to add Phan.

@Daimona has been nicely baby sitting Phan and @ Umherirrender has driven the effort to enable Phan on all Wikimedia deployed extensions and skins (T224783).

So this task has served its purpose ;)

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL